Swagger para documentação da API

Swagger é uma estrutura de software de código aberto que ajuda os desenvolvedores a projetar, construir, documentar e consumir APIs RESTful. A documentação do Swagger é uma representação de uma API RESTful que é criada usando a especificação Swagger. A especificação Swagger é uma linguagem de descrição de interface padrão para APIs REST. Ele permite que os desenvolvedores descrevam a estrutura de suas APIs e gerem documentação em um formato legível por humanos. A documentação do Swagger gerada inclui informações sobre os endpoints da API, parâmetros de solicitação e resposta e outros detalhes relevantes. Ele pode ser usado por outros desenvolvedores para entender a funcionalidade da API e fazer chamadas para ela.

características do swagger

A documentação do Swagger fornece vários recursos, incluindo:

1. Documentação interativa: permite que os desenvolvedores experimentem chamadas de API e vejam as respostas em uma interface do usuário baseada em navegador.
2. Definição de API: fornece uma definição clara, concisa e amigável do que a API faz, seus endpoints, parâmetros e respostas esperadas.
3. Geração de código: gera código de servidor e cliente em várias linguagens de programação para ajudar a acelerar o processo de desenvolvimento.
4. Validação: valida automaticamente as solicitações e respostas da API para garantir que atendam às especificações da API.
5. Geração de documentação: Gera automaticamente a documentação da API em vários formatos, incluindo HTML, JSON e YAML.
6. Colaboração: oferece suporte à colaboração entre criadores de API, desenvolvedores e partes interessadas, fornecendo um local centralizado para a documentação da API.
7. Teste: fornece um ambiente para testar chamadas de API e garantir que elas atendam ao comportamento desejado.
8. Controle de versão: oferece suporte ao controle de versão de APIs e permite que os usuários exibam e trabalhem com várias versões de uma API.

A documentação do Swagger oferece suporte a várias linguagens de programação, incluindo:

1. Java
2. Node.js
3. PHP
4. Pitão
5. Rubi
6. Ir
7. C #
8. escala
9. perl

Ativar o Swagger na inicialização do Spring

Para habilitar a documentação do Swagger em um aplicativo de inicialização por mola, você precisa seguir estas etapas:

1. Adicione as dependências springfox-swagger2 e springfox-swagger-ui ao projeto.
2. Habilite o suporte Swagger em seu aplicativo Spring Boot anotando sua classe de configuração com @EnableSwagger2.
3. Crie um bean Docket para configurar as propriedades do Swagger, como versão, título e descrição da API.
4. Anote suas APIs RESTful com anotações apropriadas do Swagger, como @Api, @ApiOperation, @ApiParam, etc.
5. Execute o aplicativo Spring Boot e acesse a interface do usuário do Swagger na URLhttp://localhost:port/swagger-ui.html, em que port é a porta HTTP na qual seu aplicativo está em execução.

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

Configurando o Swagger 2 com uma API Spring REST | Baeldung

Documentando uma API Spring REST usando OpenAPI 3.0 | Baeldung