swagger3.0.0整合

依賴

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
​
<dependency>
 <groupId>org.projectlombok</groupId>
 <artifactId>lombok</artifactId>
 <optional>true</optional>
</dependency>
        
<dependency>
 <groupId>org.apache.commons</groupId>
 <artifactId>commons-lang3</artifactId>
</dependency>

配置

spring:
 application:
   name: springfox-swagger
    
server:
 port: 8080
​
# ===== 自定義swagger配置 ===== #
swagger:
 enable: true
 application-name: ${spring.application.name}
 application-version: 1.0
 application-description: springfox swagger 3.0整合Demo
 try-host: http://localhost:${server.port}

參數配置

@Component
@ConfigurationProperties("swagger")
@Data
public class SwaggerProperties {
    /**
     * 是否開啟swagger，生產環境一般關閉，所以這里定義一個變量
     */
    private Boolean enable;
​
    /**
     * 項目應用名
     */
    private String applicationName;
​
    /**
     * 項目版本信息
     */
    private String applicationVersion;
​
    /**
     * 項目描述信息
     */
    private String applicationDescription;
​
    /**
     * 接口調試地址
     */
    private String tryHost;
}

配置類

package com.cyz.swaggertest.config.swagger;
​
import io.swagger.models.auth.In;
import org.apache.commons.lang3.reflect.FieldUtils;
import org.springframework.boot.SpringBootVersion;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.ReflectionUtils;
import org.springframework.web.servlet.config.annotation.InterceptorRegistration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
​
import java.lang.reflect.Field;
import java.util.*;
​
@Configuration
@EnableOpenApi
public class SwaggerConfig implements WebMvcConfigurer{
    private final SwaggerProperties swaggerProperties;
​
    public SwaggerConfig(SwaggerProperties swaggerProperties) {
        this.swaggerProperties = swaggerProperties;
   }
​
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30).pathMapping("/")
​
                // 定義是否開啟swagger，false為關閉，可以通過變量控制
               .enable(swaggerProperties.getEnable())
​
                // 將api的元信息設置為包含在json ResourceListing響應中。
               .apiInfo(apiInfo())
​
                // 接口調試地址
               .host(swaggerProperties.getTryHost())
​
                // 選擇哪些接口作為swagger的doc發布
               .select()
               .apis(RequestHandlerSelectors.any())
               .paths(PathSelectors.any())
               .build()
​
                // 支持的通訊協議集合
               .protocols(newHashSet("https", "http"))
​
                // 授權信息設置，必要的header token等認證信息
               .securitySchemes(securitySchemes())
​
                // 授權信息全局應用
               .securityContexts(securityContexts());
   }
​
    /**
     * API 頁面上半部分展示信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title(swaggerProperties.getApplicationName() + " Api Doc")
               .description(swaggerProperties.getApplicationDescription())
               .contact(new Contact("chen", null, "[e-mail]"))
               .version("Application Version: " + swaggerProperties.getApplicationVersion() + ", Spring Boot Version: " + SpringBootVersion.getVersion())
               .build();
   }
​
    /**
     * 設置授權信息
     */
    private List<SecurityScheme> securitySchemes() {
        ApiKey apiKey = new ApiKey("Authorization", "token", In.HEADER.toValue());
        return Collections.singletonList(apiKey);
   }
​
    /**
     * 授權信息全局應用
     */
    private List<SecurityContext> securityContexts() {
        return Collections.singletonList(
                SecurityContext.builder()
                       .securityReferences(Collections.singletonList(new SecurityReference("Authorization", new AuthorizationScope[]{new AuthorizationScope("global", "")})))
                       .build()
       );
   }
​
    @SafeVarargs
    private final <T> Set<T> newHashSet(T... ts) {
        if (ts.length > 0) {
            return new LinkedHashSet<>(Arrays.asList(ts));
       }
        return null;
   }
​
    /**
     * 通用攔截器排除swagger設置，所有攔截器都會自動加swagger相關的資源排除信息
     */
    @SuppressWarnings("unchecked")
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        try {
            Field registrationsField = FieldUtils.getField(InterceptorRegistry.class, "registrations", true);
            List<InterceptorRegistration> registrations = (List<InterceptorRegistration>) ReflectionUtils.getField(registrationsField, registry);
            if (registrations != null) {
                for (InterceptorRegistration interceptorRegistration : registrations) {
                    interceptorRegistration
                           .excludePathPatterns("/swagger**/**")
                           .excludePathPatterns("/webjars/**")
                           .excludePathPatterns("/v3/**")
                           .excludePathPatterns("/doc.html");
               }
           }
       } catch (Exception e) {
            e.printStackTrace();
       }
   }
}

• 訪問http://127.0.0.1:8150/swagger-ui/

•