Tutorial de configuración de Swagger2

Primero cree un nuevo proyecto springboot y luego importe las dependencias relacionadas con swagger en el archivo pom, que son las dos siguientes:

 Zancudo primaveral2

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

 Interfaz de usuario de Springfox Swagger 

<!-- 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>

 También puede ir al sitio web oficial de maven para descargar otras versiones de las dependencias de swagger. La dirección oficial de maven es la siguiente:

Repositorio jMaven: springfox (mvnrepository.com)https://mvnrepository.com/search?q=springfox https://mvnrepository.com/search?q=springfox

 Haga clic para ingresar al sitio web oficial de maven, busque springfox-swagger para encontrar

 Después de importar las dependencias relacionadas, si desea usar Swagger, debe configurar Swagger, crear un paquete de configuración en el proyecto y crear una clase de configuración SwaggerConfig en el paquete para configurar Swagger, de la siguiente manera:

 Escriba las anotaciones @Configuration y @EnableSwagger2 en la clase SwaggerConfig, donde @Configuration
indica que se trata de una clase de configuración; y las anotaciones @EnableSwagger2 se usan para habilitar Swagger; en este momento, Swagger está listo para usar, pero se muestra en un formato relativamente original. contenido.

Inicie el proyecto. Si la versión de springboot es demasiado alta, se puede lanzar una excepción. Se recomienda bajar la versión. Comenzaré bajando la versión de springboot a 2.5.6. Visite http://localhost:8080/swagger-ui.html después del inicio

 Luego configure el swagger en el siguiente paso, porque el bean de la instancia de Swagger es un Docket, por lo que debe configurar el Swagger configurando la instancia del Docket.

package com.hu.SpringBoot01.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.List;

@Configuration //说明这是一个配置类
@EnableSwagger2//该注解开启Swagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        //添加head参数配置start
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar.name("Authorization").description("令牌")//请求头，测试token时可以用到
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false)
                .build();
        pars.add(tokenPar.build());
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                //扫描的路径包,会将包下的所有被@Api标记类的所有方法作为api
                .apis(RequestHandlerSelectors.basePackage("com.hu.SpringBoot01.controller"))
                .paths(PathSelectors.any())//所有接口
                .build()
                .globalOperationParameters(pars);

    }
    private ApiInfo webApiInfo() {
        return new ApiInfoBuilder()
                .title("新生入学后台管理系统接口文档")
                .description("Swagger2后台管理系统在线文档")
                .contact(new Contact("胡雁南","localhost:8080/swagger-ui.html","[email protected]"))
                .version("2.1")
                .build();
    }
}

En este punto, swagger se puede usar normalmente, visite http://localhost:8080/swagger-ui.html