podcodar / voting-system

voting-system-lyart.vercel.app

1 stars 0 forks source link

api auto documentation with swagger #18

Closed vzsoares closed 2 years ago

vzsoares commented 2 years ago

Description

adds swagger as dependencie and implements it

Notes

help need with:

if and how can intefaces at /packages/entities be imported to JSDoc at swagges $ref: ' '
how to put and read /models from /packages/models
- changing schemaFolders: ['models'] to ['./packages/models'] does not seem to work

Closes #10

vercel[bot] commented 2 years ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
voting-system	❌ Failed (Inspect)		Jul 21, 2022 at 9:13PM (UTC)

frattezi commented 2 years ago

Repondendo algumas perguntas

No swagger vamos querer mapear apenas a interface mais externa da aplicação a API. Poderíamos criar entities separadas para cada endpoints, mas se não me engano, o swagger vai se basear na documentação que inserirmos no code, não sei como os dois se relacionariam.

Vou fazer a run local aqui também

frattezi commented 2 years ago

@vzsoares acho que vi uma opção legal para fazermos aqui utilizando:

Estou estudando aqui mas acho que ficaria legal, podemos quebrar em algumas tasks!