Configurando Open API no Spring Boot 3

Willyan Guimarães Caetano — Thu, 22 Dec 2022 01:03:32 +0000

O Spring Boot 3 chegou e com diversas novidades.

Se você já realizou a migração ou mesmo criou uma aplicação com a nova versão e precisa ou deseja inserir o OpenAPI para documentar suas APIs então vai uma dica importante.

Basta utilizar o springdoc-openapi, biblioteca que fornece suporte para OpenAPI nos projetos Spring.

Segue abaixo dependência necessária em projetos Maven ou Gradle:

Maven

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
      <version>2.0.2</version>
   </dependency>

Gradle

implementation group: 'org.springdoc', name: 'springdoc-openapi-starter-webmvc-ui', version: '2.0.2'

Observações importantes:

Versões inferiores a 2.0.0 da biblioteca não funcionam para Spring Boot 3
A dependência acima está relacionada com uma aplicação usando Spring Web, e não Spring WebFlux

Após adicionar a dependência, realize um teste rodando a aplicação e acessando o endereço do Swagger:

http://localhost:8080/swagger-ui/index.html

Exemplo: Github

Refs:

DEV Community: Willyan Guimarães Caetano

Configurando Open API no Spring Boot 3