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

[Documentation] - [API] - [Document All Routes Using Swagger] #94

Closed
3 tasks done
samuelncaetano opened this issue Jan 29, 2025 · 0 comments · Fixed by #112 or #130
Closed
3 tasks done

[Documentation] - [API] - [Document All Routes Using Swagger] #94

samuelncaetano opened this issue Jan 29, 2025 · 0 comments · Fixed by #112 or #130
Assignees
@LucasAlves71 @samuelncaetano
Labels
documentation Improvements or additions to documentation
Milestone
Sprint 10

Comments

@samuelncaetano
Copy link
Collaborator

samuelncaetano commented Jan 29, 2025 •
edited
Loading

Descrição

Criar a documentação completa de todas as rotas do projeto utilizando o Swagger. Isso facilitará a compreensão e integração da API por outros desenvolvedores, garantindo que todas as funcionalidades estejam bem descritas e acessíveis.

Critérios de Aceitação

  • Todas as rotas da API devem estar documentadas no Swagger.
  • A documentação deve incluir descrição, parâmetros de entrada, formato de resposta e códigos de status possíveis.
  • A interface do Swagger deve estar acessível em um endpoint específico (exemplo: /docs).

Escopo da Tarefa

  • Instalar e configurar o Swagger no projeto.
  • Documentar todas as rotas existentes, incluindo métodos, parâmetros e respostas.
  • Garantir que a documentação seja gerada automaticamente a partir do código.
@samuelncaetano samuelncaetano self-assigned this Jan 29, 2025
@samuelncaetano samuelncaetano added the documentation Improvements or additions to documentation label Jan 29, 2025
@samuelncaetano samuelncaetano added this to the Sprint 9 milestone Jan 29, 2025
samuelncaetano added a commit that referenced this issue Jan 30, 2025
@samuelncaetano
chore(package): add swagger to the project
6817eae 
Refs #94
samuelncaetano added a commit that referenced this issue Jan 30, 2025
@samuelncaetano
feat(swagger): add swagger settings to the project
32b492c 
Refs #94
samuelncaetano added a commit that referenced this issue Jan 30, 2025
@samuelncaetano
feat(user-routes): add user routes documentation
ffd088e 
Refs #94
@samuelncaetano samuelncaetano modified the milestones: Sprint 9, Sprint 10 Feb 2, 2025
@samuelncaetano samuelncaetano mentioned this issue Feb 3, 2025
Merged
11 tasks
@samuelncaetano samuelncaetano linked a pull request Feb 3, 2025 that will close this issue
docs: add user routes documentation in swagger #112
Merged
11 tasks
@samuelncaetano samuelncaetano reopened this Feb 3, 2025
@samuelncaetano samuelncaetano removed a link to a pull request Feb 3, 2025
docs: add user routes documentation in swagger #112
Merged
11 tasks
@samuelncaetano samuelncaetano linked a pull request Feb 3, 2025 that will close this issue
docs: add user routes documentation in swagger #112
Merged
11 tasks
samuelncaetano added a commit that referenced this issue Feb 13, 2025
@samuelncaetano
refactor(swagger): update swagger settings
8771cd7 
Refs #94
samuelncaetano added a commit that referenced this issue Feb 13, 2025
@samuelncaetano
docs(user-routes): update documentation of user routes
99672a8 
Refs #94
samuelncaetano added a commit that referenced this issue Feb 13, 2025
@samuelncaetano
docs(transaction-routes): add documentation of routes for financial t…
c9c011c 
…ransactions

Refs #94
LucasAlves71 added a commit that referenced this issue Feb 13, 2025
@LucasAlves71
docs(categoryroutes): add swagger documentation on the category routes
0016f05 
Refs #94
LucasAlves71 added a commit that referenced this issue Feb 13, 2025
@LucasAlves71
feat(swaggerconfig): add path to category's route
af223b3 
Refs #94
@LucasAlves71 LucasAlves71 mentioned this issue Feb 13, 2025
Merged
11 tasks
@LucasAlves71 LucasAlves71 linked a pull request Feb 13, 2025 that will close this issue
Back 94/document/document all routes #130
Merged
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@LucasAlves71 LucasAlves71

@samuelncaetano samuelncaetano

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Sprint 10
2 participants
@LucasAlves71 @samuelncaetano