API - ZosiscoIV/Dev-Web-2024 GitHub Wiki
Résumé coaching 5.a
+ Les choix de conception de l'API sont expliqués sur le Wiki : Ressources exposées, choix de nommage, technologie utilisée… Les noms et conventions utilisés sont cohérents.
+ La documentation de l'API est accessible depuis le Wiki. Elle est claire et bien organisée.
"Pour chaque ressource, une section détaille au moins :
* la description de la ressource
* les endpoints associés et les méthodes pour y accéder
* les éventuels paramètres disponibles
* un exemple de requête
* un exemple de réponse"
+ L'API respecte globalement les principes REST
+ Le groupe peut présenter un exemple fonctionnel de endpoint de l'API (par ex. avec curl). Tous les étudiants peuvent en expliquer le fonctionnement.
+ Le groupe utilise un outil adéquat dédié pour tester son API lors du développement
1. Choix de conception pour l'API
REST (Représentation State Transfer) Pourquoi ? :
- Basé sur HTTP avec des endpoints clairs (GET, POST, PUT, DELETE). => utile pour nous
- Simple et largement adopté.
- Bonne sécurité (les cliens ne peuvent pas distinguer s'ils sont connectés directement au serveur final, ou à un intermédiaire en chemin)
2. Documentation de l'API
3. Outils utilisés pour développer et tester l'API
On utilise swagger pour vérifier le bon fonctionnement des routes. On a également utilisé un container Docker pour la base de donnée et on accède à distance avec MySQL Workbench pour vérifier les manipulations. On utilise Node.js et express pour faire les requêtes vers la base de données.