Documentation de l'API

Cette page reprendra l'ensemble des endpoints publiés par votre API. Par souci de clarté, organisez cette page :

• En commençant par un résumé des ressources, avec un lien vers la section correspondante
• Ensuite, pour chaque ressource de votre API, 5 éléments doivent être fournis :
  • Une description de la ressource (ex : la ressource est un produit proposé par le commerce en ligne)
  • Les endpoints liés à cette ressource et les méthodes accessibles Ex : GET /products/ => Fournit les informations spécifiques au produit avec l'ID indiqué
  • Pour chaque endpoint, les paramètres éventuellement disponibles pour préciser la requête
  • Un exemple de requête (Méthode + URL, ou encore, la ligne de commande Curl qui permet de tester le endpoint)
  • Un exemple de réponse (Par ex. l'objet JSON renvoyé par le serveur)

Voir par exemple l'API Github (ici, la partie concernant les issues)

N'hésitez pas à faire le lien entre votre documentation et vos tests sur Postman.