op-ent / api

https://github.com/op-ent/op-ent/tree/main/apps/api
GNU General Public License v3.0
5 stars 1 forks source link

Swagger #10

Closed florian-lefebvre closed 1 year ago

florian-lefebvre commented 2 years ago

A voir comment on peut mettre en place Swagger pour documenter l'API. Il faut aussi regarder comment intégrer les specs OpenApi.

florian-lefebvre commented 1 year ago

Je pense que le plus simple c'est de setup swagger avec docker (super facile avec docker compose) et de renseigner une spec json à la main. Si on s'y met rapidement, il suffit de compléter la doc à chaque fois qu'on rajoute des endpoints. Je pense pas que ça vaille le coup de créer un vrai package Swagger pour Adonis, comme https://github.com/nestjs/swagger

florian-lefebvre commented 1 year ago

Bonne idée !