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: add user routes documentation in swagger #112

Merged
merged 3 commits into from
Feb 3, 2025

Conversation

samuelncaetano
Copy link
Collaborator

@samuelncaetano samuelncaetano commented Feb 3, 2025

Descrição

Esta pull request adiciona a documentação das rotas da API utilizando Swagger. Foram incluídas novas dependências para suportar essa funcionalidade, além da atualização de pacotes existentes.

Tipo de alteração

  • Bugfix
  • Nova funcionalidade
  • Alteração de funcionalidade existente
  • Refatoração
  • Documentação
  • Outro (descreva abaixo)

Como isso foi testado?

Foram realizados testes manuais para garantir que a documentação via Swagger foi corretamente integrada e está acessível através do endpoint apropriado. A documentação foi validada para garantir que todas as rotas estão bem descritas e funcionam conforme esperado.

Checklist

  • O código segue o estilo de codificação e as convenções do projeto.
  • Os testes foram adicionados ou atualizados para refletir as alterações.
  • A documentação foi atualizada, se necessário.
  • A mudança não quebra funcionalidades existentes.
  • O código foi revisado e testado localmente.

Referências

Refs #94

@samuelncaetano samuelncaetano linked an issue Feb 3, 2025 that may be closed by this pull request
3 tasks
@samuelncaetano samuelncaetano changed the title Back 94/document/swagger api documentation docs: add user routes documentation in swagger Feb 3, 2025
@samuelncaetano samuelncaetano merged commit 4473d1e into main Feb 3, 2025
1 check passed
@samuelncaetano samuelncaetano deleted the back-94/document/swagger-api-documentation branch February 3, 2025 21:27
@samuelncaetano samuelncaetano linked an issue Feb 3, 2025 that may be closed by this pull request
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Documentation] - [API] - [Document All Routes Using Swagger]
1 participant