servicosgovbr / manual-roteiro-integracao-login-unico

Roteiro de Integração do Login Único para os órgãos
https://manual-roteiro-integracao-login-unico.servicos.gov.br
41 stars 16 forks source link

Existe documentação no formato OpenAPI? #37

Open glauberferreira opened 5 months ago

glauberferreira commented 5 months ago

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 commented 1 month ago

Alguma informação a respeito deste ponto?

weltonrodrigo commented 1 month ago

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

glauberferreira commented 1 month ago

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.