Lorenalgm/DevChallengeAPI

Adicionar Swagger para documentar API

ramos-ph opened this issue · 1 comments

ramos-ph commented

Atualmente, estamos utilizando um arquivo REFERENCE.md para documentar a API.

Isso não é bom porque não temos uma forma de testar com facilidade. Podemos adicionar um documento com Swagger para documentar e deixar testável a API.

Você poderia resolver essa Issue com um Pull Request?

  • Sim, eu tenho tempo e posso começar.
  • Sim, eu tenho tempo mas precisaria de alguém para me direcionar.
  • Não, eu não tenho tempo mas poderia solucionar.
  • Não, eu não tenho tempo e não sei por onde começar.
AldairAvelino commented

Atualmente, estamos utilizando um arquivo REFERENCE.md para documentar a API.

Isso não é bom porque não temos uma forma de testar com facilidade. Podemos adicionar um documento com Swagger para documentar e deixar testável a API.

Você poderia resolver essa Issue com um Pull Request?

  • Sim, eu tenho tempo e posso começar.
  • Sim, eu tenho tempo mas precisaria de alguém para me direcionar.
  • Não, eu não tenho tempo mas poderia solucionar.
  • Não, eu não tenho tempo e não sei por onde começar.