docs: Créer le fichier API_DOCUMENTATION.md

[benoit-bremaud]

Résumé

Rédiger un fichier API_DOCUMENTATION.md pour fournir une documentation détaillée de l'API de l'application HappiHub.

Contexte

Une documentation API claire et complète est essentielle pour que les développeurs puissent comprendre comment interagir avec l'API HappiHub.

Objectifs

• Créer un fichier API_DOCUMENTATION.md dans le dossier docs/API/.
• Documenter chaque endpoint de l'API avec des descriptions, des paramètres, et des exemples de requêtes et réponses.

Critères d'Acceptation

• Le fichier API_DOCUMENTATION.md doit être présent dans le dossier docs/API/.
• Le fichier API_DOCUMENTATION.md doit inclure des descriptions détaillées de chaque endpoint de l'API.
• Le fichier doit inclure des exemples de requêtes et de réponses.

Tâches

• Rédiger le fichier API_DOCUMENTATION.md.
• Documenter les endpoints de l'API.
• Inclure des descriptions des paramètres et des exemples de requêtes et réponses.

Ressources

• Swagger Documentation
• Postman API Documentation

Diagrammes UML Référents

• Diagramme de Séquence : Pour visualiser le flux des opérations et l'interaction avec les endpoints.

Nom de la Branche

docs/api-documentation