Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[sugestão] criar documentação da API #555

Open
imattferreira opened this issue Jul 23, 2022 · 5 comments
Open

[sugestão] criar documentação da API #555

imattferreira opened this issue Jul 23, 2022 · 5 comments
Labels
documentação Documentação e organização de processos

Comments

@imattferreira
Copy link

E aí turma!

Como no futuro esse projeto vai se tornar público, e até, para melhorar a DX para os novos devs que querem se aventurar no projeto (assim como eu kk), queria propor de a gente implementar alguma documentação da API.

De lib para montar a documentação, uma que particularmente gostei muito foi a Redoc, que foi até implementada no BrasilAPI.

O que vocês acham?
@gabrielsozinho
Copy link
Contributor

Opa, eu to trabalhando na criação da documentação. Primeiro eu vou postar lá no TabNews mesmo, e se aceito, depois a gente implementa a Redoc. O que acha?

@imattferreira
Copy link
Author

Opa, eu to trabalhando na criação da documentação. Primeiro eu vou postar lá no TabNews mesmo, e se aceito, depois a gente implementa a Redoc. O que acha?

TOP! Gostei da ideia.

@gabrielsozinho
Copy link
Contributor

Acabei de publicar a primeira versão da documentação lá no TabNews!
https://www.tabnews.com.br/GabrielSozinho/documentacao-da-api-do-tabnews

@gabrielsozinho gabrielsozinho mentioned this issue Jul 24, 2022
Closed
@CarlosZiegler
Copy link

Massa, acabei criando um PR usando Redoc:
#599

@Rafatcb Rafatcb added the documentação Documentação e organização de processos label Aug 2, 2022
@aprendendofelipe
Copy link
Collaborator

aprendendofelipe commented Oct 6, 2023 •
edited

Apenas registrando aqui os PRs que já foram abertos e que podem servir de inspiração para a criação de um PR atualizado:

This was referenced Oct 6, 2023
Closed
Closed
Closed
Closed
Closed
@Rafatcb Rafatcb mentioned this issue Dec 8, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentação Documentação e organização de processos
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@Rafatcb @CarlosZiegler @imattferreira @aprendendofelipe @gabrielsozinho