📑 Configurar Swagger para documentação da API

[Edwanderson]

Issue: 📄 Configurar e Testar Swagger para Documentação da API

Descrição:

Integrar o Swagger para fornecer uma interface visual e documentação da nossa API REST, facilitando a visualização e teste dos endpoints.

Tarefas:

• [ ] 📦 Adicionar dependências do Swagger no pom.xml
• [ ] 🔄 Configurar o Swagger para a aplicação
• [ ] 🛠️ Testar os endpoints da API na interface do Swagger

Código de exemplo:

1. Adicionar dependências do Swagger no pom.xml:

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

2. Configurar o Swagger:

package com.example.demo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

3. Testar a API no Swagger UI:

Acesse a interface do Swagger em:

http://localhost:8080/swagger-ui/

Explicação:

• Dependência do Swagger: Adicionamos a dependência no pom.xml para incluir o Swagger na aplicação.
• Configuração do Swagger: Criamos a classe SwaggerConfig que define como o Swagger deve ser configurado, especificando os pacotes de controle e os caminhos que devem ser documentados.
• Interface do Swagger UI: Após a configuração, a interface pode ser acessada via URL, permitindo visualizar e testar os endpoints da API. Com esta etapa, você terá documentação interativa da sua API, permitindo fácil acesso aos endpoints.