Incompatibilidade do Swagger com versão do Spring 3.x

#Spring
#Java

A configuração de documentação para APIs pode ser um desafio, especialmente quando se trata de garantir a compatibilidade entre diferentes versões de bibliotecas. Neste artigo, vamos explorar uma abordagem recomendada para configurar a documentação da sua API usando o Springdoc.

Dependências Recomendadas

Ao invés de usar as dependências do Springfox, que podem causar incompatibilidade entre as versões do Swagger e do Spring, sugerimos a utilização do Springdoc, que é mais atualizado e fácil de integrar.

Adicione a seguinte dependência ao seu arquivo pom.xml:

xml

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

Exemplo de Controller com Anotações

Em seguida, você pode anotar seus métodos diretamente nas classes de controle, o que facilita a documentação de sua API. Veja um exemplo de como configurar uma controller com anotações do OpenAPI:

Java

@RestController
@RequestMapping("/api/hello")
public class HelloController {

  @GetMapping
  @Operation(summary = "Saudação")
  @ApiResponses(value = {
          @ApiResponse(responseCode = "200", description = "Saudação bem-sucedida"),
          @ApiResponse(responseCode = "500", description = "Erro interno no servidor")
  })
  public String sayHello() {
      return "Olá, mundo!";
  }
}

Acessando a Documentação

Após a configuração, você pode acessar a documentação gerada automaticamente da seguinte forma:

Documentação OpenAPI JSON: http://localhost:8080/v3/api-docs
Interface Swagger UI: http://localhost:8080/swagger-ui.html

Com essas configurações, você simplifica o processo de documentação e garante que sua API esteja bem documentada e fácil de usar por outros desenvolvedores.

Espero que essas orientações ajudem você a configurar a documentação da sua API de maneira mais eficiente e eficaz!