DevChallengeAPI icon indicating copy to clipboard operation
DevChallengeAPI copied to clipboard

Adicionar Swagger para documentar API

Open ramos-ph opened this issue 3 years ago • 1 comments

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?

  • [x] 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.

ramos-ph avatar Dec 06 '21 17:12 ramos-ph

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?

  • [x] Sim, eu tenho tempo e posso começar.
  • [x] 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 avatar Jun 15 '22 13:06 AldairAvelino