Configurando Swagger Springfox em um projeto Spring Boot

O Swagger é uma ferramenta de software que permite documentar APIs de maneira fácil e padronizada. O Springfox é uma biblioteca que pode ser integrada com o Spring Boot para gerar a documentação da API usando o Swagger.

Aqui estão os passos para configurar o Swagger Springfox em um projeto Spring Boot:

Adicione as dependências necessárias

O primeiro passo é adicionar as dependências necessárias ao arquivo pom.xml (no caso de projetos Maven) ou build.gradle (no caso de projetos Gradle). As dependências são:

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

Configure o Swagger

Em seguida, é necessário configurar o Swagger em sua aplicação Spring Boot. Isso pode ser feito criando uma classe de configuração com a anotação @EnableSwagger2:

@Configuration
@EnableSwagger2
public class SwaggerConfig {    
    @Bean
    public Docket api() { 
        return new Docket(DocumentationType.SWAGGER_2)  
          .select() 
          .apis(RequestHandlerSelectors.any())              
          .paths(PathSelectors.any())                          
          .build();                                           
    }
}

A classe Docket é usada para configurar as opções do Swagger, como as APIs e os endpoints a serem documentados.

Anote os controladores

Por fim, é necessário anotar os controladores da API com as anotações apropriadas do Swagger. Por exemplo:

@RestController
@RequestMapping("/api")
@Api(value = "API de exemplo", description = "Exemplo de API com Swagger")
public class ExemploController {
    @ApiOperation(value = "Exemplo de endpoint", response = String.class)
    @GetMapping("/exemplo")
    public String exemplo() {
        return "Exemplo de API com Swagger";
    }
}

A anotação @Api é usada para definir o valor e a descrição da API, enquanto a anotação @ApiOperation é usada para definir o valor e o tipo de resposta de um endpoint.

Com esses passos, o Swagger Springfox deve estar configurado e pronto para uso em sua aplicação Spring Boot. Para acessar a interface do usuário do Swagger, basta acessar a URL http://localhost:<porta>/swagger-ui.html, onde <porta> é a porta na qual sua aplicação Spring Boot está sendo executada.