Closed fuhrmanator closed 2 months ago
Au fait, quelqu'un a fait un article de blogue à propos de apidoc et REST et on devrait le suivre: https://jonathas.com/documenting-your-nodejs-api-with-apidoc/
Parfois un endpoint se décrit par son nom, p.ex. all plutôt que l'explication de ce qu'il fait, Récupérer la liste de tous les cours
On doit normaliser la doc de l'API selon les conseils dans le blogue https://jonathas.com/documenting-your-nodejs-api-with-apidoc/ par exemple.
J'ai aussi corrigé la documentation de fromtoken
qui était incorrecte.
Lorsqu'on génère la doc avec apidoc, il y a des erreurs de ce genre:
Je pense que c'est parce que
insert
est un POST (plutôt qu'un GET) et puisstudent_id
est dans le body de la requête plutôt que dans l'URL. Probablement apidoc veut questudent_id
soit un@apiBody
plutôt qu'un@apiParam
.EDIT: j'ai corrigé ce pb dans dde5bd3