Skip to content
Ichiky_Otsu edited this page Jun 9, 2024 · 6 revisions

Rapport de développement de l'API

1. Choix de conception pour l'API

Pour développer notre API, nous avons choisi d'utiliser Express JS en tant que framework principal. Express JS est largement utilisé dans l'écosystème Node.js pour construire des applications web et des API en raison de sa simplicité et de sa flexibilité.

En ce qui concerne la documentation de notre API, nous avons décidé d'utiliser Swagger. Swagger nous permet de générer une documentation automatique à partir de nos routes API, ce qui facilite la compréhension de l'API pour les développeurs tiers. Cependant, nous avons également pris le temps de peaufiner manuellement la documentation générée par Swagger pour nous assurer qu'elle est claire, précise.

2. Documentation de l'API

Vous pouvez consulter la documentation de notre API en suivant ce lien : Documentation de l'API

La documentation de l'API comprend des informations détaillées sur les différentes routes disponibles, les paramètres acceptés, les réponses renvoyées et d'autres détails importants pour utiliser efficacement l'API.

3. Outils utilisés pour développer et tester l'API

Nous avons utilisé une gamme d'outils pour développer et tester notre API, notamment :

  • Express JS: Framework principal pour développer l'API.
  • Swagger: Utilisé pour générer automatiquement la documentation de l'API.
  • npm: Gestionnaire de paquets JavaScript utilisé pour installer et gérer les dépendances du projet.