studies
Documentando API (Swagger e OpenAPI)
HomePrincípios de Programação Orientada a ObjetosTrabalhando com ObjetosTrabalhando com CollectionsTrabalhando com StringsTrabalhando com ExceptionsApi, camadas, CRUD, exceptions, validationProjeto Arquitetura RESTfulCriando um projeto REST / RESTfulSPRING DATA JPA - 2024Estudo Arquitetura LimpaEstudo sobre Anotações SpringModelo de Dominio e ORMAPI REST, camadas, CRUD, exceções, validaçõesJPA, Consultas SQL e JPQLLogin e controle de acessoTestes automatizados, JUnit5 e MockitoValidação e SegurançaSignup e finalizaçãoCobertura de testes com JaCoCoTestes API - MockMvc e RestAssuredEstudo Definitivo ORMEstudo upload arquivos AWSDocumentando API (Swagger e OpenAPI)Versionamento de APIHateoasWorkshop MongoDBWorkshop CassandraSpring Webflux - MongoDBSpring Batch - IntrodutórioSpring Batch Avançado - Lendo dados API remotaSpring Batch - Envio de Email em massaRoad map estudo
Documentando API (Swagger e OpenAPI)
HomePrincípios de Programação Orientada a ObjetosTrabalhando com ObjetosTrabalhando com CollectionsTrabalhando com StringsTrabalhando com ExceptionsApi, camadas, CRUD, exceptions, validationProjeto Arquitetura RESTfulCriando um projeto REST / RESTfulSPRING DATA JPA - 2024Estudo Arquitetura LimpaEstudo sobre Anotações SpringModelo de Dominio e ORMAPI REST, camadas, CRUD, exceções, validaçõesJPA, Consultas SQL e JPQLLogin e controle de acessoTestes automatizados, JUnit5 e MockitoValidação e SegurançaSignup e finalizaçãoCobertura de testes com JaCoCoTestes API - MockMvc e RestAssuredEstudo Definitivo ORMEstudo upload arquivos AWSDocumentando API (Swagger e OpenAPI)Versionamento de APIHateoasWorkshop MongoDBWorkshop CassandraSpring Webflux - MongoDBSpring Batch - IntrodutórioSpring Batch Avançado - Lendo dados API remotaSpring Batch - Envio de Email em massaRoad map estudo
  • Objetivo
  • Definição de documentação
  • Formas de Documentar
  • Especificações de documentação
  • Swagger
    • Classe config - customização
    • Recursos swagger (tags)
    • Anotações model (tags em DTO)
    • Swagger + Spring security
  • Readme
Fornecido por GitBook
Nesta página

Readme

AnteriorSwagger + Spring security

Atualizado há 5 meses

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.