search

profcfuhrmanets / log210-systeme-gestion-bordereau-node-express-ts

Système de gestion des bordereaux (SGB) utilisé dans le cadre du cours de LOG210.
https://profcfuhrmanets.github.io/log210-systeme-gestion-bordereau-node-express-ts/
0 stars 17 forks source link

Incohérences dans les annotations pour apidoc #29

Closed fuhrmanator closed 2 months ago

fuhrmanator commented 2 months ago

Lorsqu'on génère la doc avec apidoc, il y a des erreurs de ce genre:

warn: @apiParam 'student_id' was defined but does not appear in URL of @api 'insert' in file: 'src\routes\GradeRouter.ts'

Je pense que c'est parce que insert est un POST (plutôt qu'un GET) et puis student_id est dans le body de la requête plutôt que dans l'URL. Probablement apidoc veut que student_id soit un @apiBody plutôt qu'un @apiParam.

EDIT: j'ai corrigé ce pb dans dde5bd3

fuhrmanator commented 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/

fuhrmanator commented 2 months ago

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.

Olon11 commented 2 months ago

J'ai aussi corrigé la documentation de fromtoken qui était incorrecte.