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

Existe documentação no formato OpenAPI? #37

Open
glauberferreira opened this issue Apr 18, 2024 · 3 comments
Open

Existe documentação no formato OpenAPI? #37

glauberferreira opened this issue Apr 18, 2024 · 3 comments

Comments

@glauberferreira
Copy link

Existe documentação da API do Login Único Acesso GovBR no formato OpenAPI (Swagger)? Estou usando o Backstage para catalogar as APIs utilizadas nos nossos projetos e o arquivo YAML de definição da API é obrigatório.

@glauberferreira
Copy link
Author

Alguma informação a respeito deste ponto?

@weltonrodrigo
Copy link

Seria legal se você pudesse construir um e abrir um PR adicionando ao manual.

@glauberferreira
Copy link
Author

Seria legal se você pudesse construir um e abrir um PR adicionando ao manual.

Vou tentar iniciar este trabalho @weltonrodrigo.

Mas antes, queria saber se a equipe de desenvolvimento do Login Único não poderia incluir essa documentação junto à própria implementação? Em vez de criarmos um JSON/YAML standalone com a especificação OpenAPI, talvez fosse melhor incluir anotações no próprio código-fonte para que a documentação OpenAPI seja gerada.

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

No branches or pull requests

2 participants