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.

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

docs(api): add openapi definitions & redoc #799

Closed

Conversation

coffeeispower
Copy link
Contributor

Esse PR adiciona documentação da API usando redoc e open api.

A documentação está disponivel em /api-docs/index.html

@coffeeispower coffeeispower added the documentação Documentação e organização de processos label Oct 31, 2022
@coffeeispower coffeeispower self-assigned this Oct 31, 2022
@coffeeispower coffeeispower linked an issue Oct 31, 2022 that may be closed by this pull request
@vercel
Copy link

vercel bot commented Oct 31, 2022

@coffee-is-power is attempting to deploy a commit to the TabNews Team on Vercel.

To accomplish this, @coffee-is-power needs to request access to the Team.

Afterwards, an owner of the Team is required to accept their membership request.

If you're already a member of the respective Vercel Team, make sure that your Personal Vercel Account is connected to your GitHub account.

@gabrielsozinho
Copy link
Contributor

Parabéns pela documentação! Mas tenho alguns pontos a destacar.

  1. o @CarlosZiegler já não havia iniciado uma documentação usando Redoc no PR docs: Adiciona documentação da API #599?
  2. mesmo que ele tenha apenas iniciado e você tenha feito concluindo tudo, não acho que essa seja a organização de endpoints que vá pra documentação em produção. Você pode ver o comentário do Filipe nesse link.
  3. Eu estava me preparando para uma prova, então nem comecei a fazer uma documentação nesse novo formato. Fiz a prova hoje, e a partir de amanhã começarei a fazer ela, ai depois você pode alterar para essa nova organização.

@coffeeispower
Copy link
Contributor Author

coffeeispower commented Nov 7, 2022

O @CarlosZiegler tinha começado, mas tava parado já faz quase um ano e eu precisava de uma documentação, ent eu fiz essa em 2 dias, e mesmo se não for pra produção eu tenho uma versão hospedada no GH pages.
Tem algumas coisas pra melhorar como os exemplos e a organização, mas documenta a maior parte se não for tudo.

@aprendendofelipe
Copy link
Collaborator

@coffee-is-power, obrigado pelo PR! 💪

Registrei a existência dele na issue sobre a documentação da API (#555), então esse trabalho pode ser aproveitado em um PR atualizado.

Vou fechar esse por enquanto. 👍

@Rafatcb Rafatcb deleted the 798-criar-documentação-usando-openapi-e-redoc branch March 9, 2024 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentação Documentação e organização de processos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Criar documentação usando OpenAPI e Redoc
4 participants