Readme

Gerar especificação OpenAPI da API

Cadastre-se no readme, e crie um novo projeto, faça um upload de uma imagem.

Ele nos dá a opção de importar a nossa API. A melhor forma de fazer isso é gerar uma especificação do OpenAPI;

• Specify the path of the OpenAPI documentation

A url padrão é essa:

springdoc.api-docs.path=/api-docs

Colocar no application.properties ⬆️

• Acessar especificação: http://localhost:8080/api-docs

Retorno postman:

Ela contém todas as informações da API, endpoints, retornos, titulo, versão, tags com nome de controllers, tudo.

Vamos validar para ver se essa especificação gerada é valida. Usaremos swagger-parser

Clicar em ‘online’ demo > validate text > cola o retorno do postman.

Cria um JSON do retorno do postman (pode ser com sublime ou yaml).

Voltamos para o site readme > OpenAPI upload > file > insere o JSON salvo > write documentation.

Vai para API Reference e tudo estará pronto para editar.