API

API

[Explication des choix de conception de l'API : Principes de nommage, technologie utilisée, outils,...]

Principes de nommage

Nous utilisons des noms qui représentent les ressources manipulées ainsi que des URL significatives qui représentent l'organisation logique de nos ressources.

Les codes http appropriés sont utilisés pour indiquer le résultat d'une information, par exemple 200 Ok si une opération est réussie.

Technologie utilisée

Nous utilisons swagger-autogen pour la génération de la documentation et swagger-ui pour afficher l'API dans le browser. Swagger est un ensemble d'outils qui facilite la conception et la documentation d'API.

Ressources exposées

shoes

La ressource shoes représente les chaussures disponibles sur le site web WeThePast. Elle permet aux utilisateurs de d'accéder à différents détails des chaussures et des les trier selon des paramètres précis.

GET seed

GET search/{searchTerm}

GET tags

GET tag/{tagName}

GET {shoesId}

users

La ressource users représente les utilisateurs du site web. On peut créer un nouvel utilisateur, obtenir des informations sur un utilisateur donné ou mettre à jour ces informations tel que son mail ou son mot de passe.

GET seed

POST login

POST register

orders

POST create

GET newOrderForCurrentUser

POST pay

La ressource orders représente les commandes effectuées par les utilisateurs sur le site web. Elle permet de créer un nouvelle commande, de mettre à jour les informations de commandes déjà passées et de suivre l'avancement des commandes en cours.

Lien vers la liste des endpoints documentés

[ Pour rappel :

• 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 :
  • 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]