ApiDoc
La documentation de l'API est générée à l'aide de apiDoc. Vous pouvez la retrouver ici.
Ou alors, vous pouvez la générer vous-même en utilisant la commande suivante :
npm run apidoc
Cela générera un dossier apidoc contenant la documentation de l'API sous la forme d'un fichiers HTML.
Afin de visualiser la documentation, ouvrez le fichier index.html dans votre navigateur.
La documentation est générée automatiquement à partir des commentaires dans le code, ce qui permet de maintenir la documentation à jour avec le code. Chaque route de l'API est documentée avec des informations sur les paramètres d'entrée, les réponses et les erreurs possibles.