SpringBoot integra Swagger2 e o usa facilmente

1. Introdução ao Swagger

Simplificando, Swagger é uma API para a interface de back-end da Web. É mais usada em projetos de separação de front-end e back-end. É usada principalmente para conectar-se com o front-end. Ela segue o estilo Restful API!
Para uma introdução ao swagger, você pode ver diretamente o documento oficial

2. Introduzido no projeto web springboot

Primeiro, crie um novo projeto web springboot e, em seguida, adicione dependências swagger2 no arquivo pom!

2.1 Adicionar dependência do Swagger

Você pode encontrar as dependências do Swagger no warehouse do Maven . Aqui você precisa adicionar duas dependências, swagger2 e swagger ui, da seguinte forma:

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

2.2 Configurando a classe SwaggerConfig

Crie um novo pacote de configuração no diretório da classe de inicialização do projeto springboot e crie uma nova classe SwaggerConfig no pacote, o conteúdo é o seguinte:

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2  // 开启 Swagger2 localhost:9000/swagger-ui.html
public class SwaggerConfig {
    
    
}

Inicie o projeto springboot para usar o swagger, visite localhost:8080/swagger-ui.html

3. Uso simples do Swagger

3.1 Modifique as informações da página de boas-vindas

@Configuration
@EnableSwagger2  // 开启 Swagger2 localhost:9000/swagger-ui.html
public class SwaggerConfig {
    
    

    // 配置 Swagger2 的 bean 实例
    @Bean
    public Docket docket(){
    
    
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("X0235")
                .select()
                // RequestHandlerSelector：配置扫描接口的方式
                // basePackage：指定要扫描的包
                // any()：扫描全部
                // none()：不扫描
                .apis(RequestHandlerSelectors.basePackage("com.dublbo.swagger.controller"))
                .build();
    }

    // 配置 Swagger 信息
    private ApiInfo apiInfo(){
    
    
        Contact contact = new Contact("独步凌波", "https://www.baidu.com", "mail.163.com/dubulingbo");
        return new ApiInfo("这是Swagger测试文档",
                "留恋处，兰舟催发，执手相看泪眼，竟无语凝噎！",
                "v1.0",
                "https://www.github.com",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList<>());
    }
}