Evolution Documentation API

[nicolas-viennot-beta]

Besoin : faciliter la compréhension de notre API Trajet en complétant la documentation d'une représentation sous forme de mapping

Objectif : clarifier les interactions et faciliter la communication avec les opérateurs

Proposition : Faire un mapping imbriquant

• Diagrammes de Séquence

illustre comment les différentes parties d'une API interagissent au fil du temps.

Montre le flux entre plusieurs services au sein d'une architecture microservices.

• API Endpoint Maps

Donne un aperçu des différents endpoints disponibles et de leurs relations (par exemple, hiérarchies, regroupements par fonctionnalités).

inclue des informations sur les méthodes HTTP (GET, POST, etc.) et les paramètres associés à chaque endpoint.

[nicolas-viennot-beta]

vérifier la limite des 48h sur le finalize

[github-actions]

Ce ticket est marqué comme obsolète car cela fait 60 jours qu'il n'y a pas eu d'activité dessus. Retirez ce label ou ajoutez un commentaire sinon ce ticket sera fermé dans 5 jours.