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

feat: swagger ui #51

Merged
merged 5 commits into from
Mar 3, 2024
Merged

feat: swagger ui #51

merged 5 commits into from
Mar 3, 2024

Conversation

izaiasmachado
Copy link
Owner

@izaiasmachado izaiasmachado commented Mar 2, 2024 •
edited
Loading

Issue

A descrição automatizada usando OpenAPI é muito usada para documentar APIs de forma automatizada. Então implementei isso no nosso projeto.

Proposta deste PR

  • Documentação automática usando OpenAI
  • Documentar controllers

Impactos deste PR

  • Uso da biblioteca org.springdoc
  • Documentação das rotas dos controllers e também os possíveis status de resposta e o que os causou.

Evidências de teste

  1. Acesse http://localhost:8080/docs e procure a rota /auth/login
Screenshot 2024-03-02 at 12 18 47
  1. Logue com seu usuário e copie o token de acesso gerado, sem a parte inicial Bearer
Screenshot 2024-03-02 at 12 28 27
  1. Clique em Authorize, cole o token e clique para se autenticar
image

@izaiasmachado izaiasmachado marked this pull request as ready for review March 2, 2024 15:39
@JonasFortes12 JonasFortes12 self-requested a review March 3, 2024 14:56
JonasFortes12
JonasFortes12 approved these changes Mar 3, 2024
View reviewed changes
Copy link
Collaborator

@JonasFortes12 JonasFortes12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

image
image

@izaiasmachado izaiasmachado merged commit 67dde96 into main Mar 3, 2024
4 checks passed
@izaiasmachado izaiasmachado deleted the feature/swagger-ui branch March 3, 2024 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JonasFortes12 JonasFortes12 JonasFortes12 approved these changes

@williambrunos williambrunos Awaiting requested review from williambrunos

@yannluk4 yannluk4 Awaiting requested review from yannluk4

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@izaiasmachado @JonasFortes12