[FEATURE/SUGESTÃO] Disponibilizar a documentação da API do tabnews via Swagger ou outra ferramenta

[yuhrao]

Acho que seria interessante e até estimularia a galera a se utilizar mais das APIs se houvesse uma documentação mais explícita e de fácio acesso. Acho que o Swagger 2 (ou OpenAPI 3) serviriam bem. Além de ser uma abordagem legal pra apenas abrir a página e experimentar as requests, é uma maneira bem automatizada de manter a documentação sempre atualizada.

Também há a possibilidade de usar ferramentas como o Read The Docs, mas acho que seria mais trabalhoso.

A lib que eu vi o pessoal mais utilizando é essa aqui: next-swagger-doc. Eu experimentei e não tive problemas

Também tem o Redoc que parece ser interessante e mais bonitinho até ahha A maior vantagem dele é que a interface mobile é bem boa

[EduardoSpek]

O usuário coffeeispower já desenvolveu uma muito bacana:

Documentação da API do TabNews

Veja também o post que ele fez sobre a documentação lá no TabNews:

Post feito pelo coffeeispower

[joseribeiroejrs]

Alguém sabe como anda a análise do PR dele? Isso ao meu ver é algo essencial e que vai ajudar muitooooo. Também senti muita falta disso.

[gabrielsozinho]

@joseribeiroejrs vai ser analisado na próxima milestone,

[aprendendofelipe]

@yuhrao, obrigado pelas sugestões! 💪

Vou fechar essa issue para centralizarmos na #555. Combinado? 🤝