spring boot 集成 springfox 3.0.0

springfox 3.0.0 上線之后，調整自己的工程

1. pom中添加依賴

<dependency>
 <groupId>io.springfox</groupId>
 <artifactId>springfox-boot-starter</artifactId>
 <version>3.0.0</version>
</dependency>
<dependency>
 <groupId>com.alibaba</groupId>
 <artifactId>fastjson</artifactId>
 <version>1.2.78</version>
</dependency>
<dependency>
 <groupId>org.apache.commons</groupId>
 <artifactId>commons-lang3</artifactId>
</dependency>
<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-configuration-processor</artifactId>
 <optional>true</optional>
</dependency>

2. 在main主入口中添加注解@EnableOpenApi

@SpringBootApplication
@EnableOpenApi
public class SpringfoxApplication {

 public static void main(String[] args) {
 SpringApplication.run(SpringfoxApplication.class, args);
 }

}
3. 配置swaaper UI的配置

package com.example.springfox.config;


import com.fasterxml.classmate.TypeResolver;
import io.swagger.annotations.ApiOperation;
import io.swagger.models.auth.In;
import org.apache.commons.lang3.reflect.FieldUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringBootVersion;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.util.ReflectionUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.context.request.async.DeferredResult;
import org.springframework.web.servlet.config.annotation.*;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.builders.ResponseBuilder;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.schema.ScalarType;
import springfox.documentation.schema.WildcardType;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger.web.*;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.lang.reflect.Field;
import java.time.LocalDate;
import java.util.*;

import static java.util.Collections.singletonList;
import static springfox.documentation.schema.AlternateTypeRules.newRule;


/**
 * @author: hett
 * @date: 2022/1/14 15:19
 */
@EnableOpenApi
@Configuration
public class SwaggerUIConfig implements WebMvcConfigurer {

 private final SwaggerProperties swaggerProperties;

 public SwaggerUIConfig(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("lighter", null, "[e-mail]"))
 .version("Application Version: " + swaggerProperties.getApplicationVersion() + ", Spring Boot Version: " + SpringBootVersion.getVersion())
 .build();
 }

 /**
 * 設置授權信息
 */
 private List<SecurityScheme> securitySchemes() {
 ApiKey apiKey = new ApiKey("BASE_TOKEN", "token", In.HEADER.toValue());
 return Collections.singletonList(apiKey);
 }

 /**
 * 授權信息全局應用
 */
 private List<SecurityContext> securityContexts() {
 return Collections.singletonList(
 SecurityContext.builder()
 .securityReferences(Collections.singletonList(new SecurityReference("BASE_TOKEN", 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();
 }
 }
}

創建屬性配置文件：
package com.example.springfox.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * @author: hett
 * @date: 2022/1/17 8:54
 */
@Component
@ConfigurationProperties("swagger")
public class SwaggerProperties {
 /**
 * 是否開啟swagger，生產環境一般關閉，所以這里定義一個變量
 */
 private Boolean enable;

 /**
 * 項目應用名
 */
 private String applicationName;

 /**
 * 項目版本信息
 */
 private String applicationVersion;

 /**
 * 項目描述信息
 */
 private String applicationDescription;

 /**
 * 接口調試地址
 */
 private String tryHost;

 public Boolean getEnable() {
 return enable;
 }

 public void setEnable(Boolean enable) {
 this.enable = enable;
 }

 public String getApplicationName() {
 return applicationName;
 }

 public void setApplicationName(String applicationName) {
 this.applicationName = applicationName;
 }

 public String getApplicationVersion() {
 return applicationVersion;
 }

 public void setApplicationVersion(String applicationVersion) {
 this.applicationVersion = applicationVersion;
 }

 public String getApplicationDescription() {
 return applicationDescription;
 }

 public void setApplicationDescription(String applicationDescription) {
 this.applicationDescription = applicationDescription;
 }

 public String getTryHost() {
 return tryHost;
 }

 public void setTryHost(String tryHost) {
 this.tryHost = tryHost;
 }
}
yaml配置文件

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}

4. 使用

@SpringBootApplication
@EnableWebMvc
public class SpringfoxApplication {

 public static void main(String[] args) {
 SpringApplication.run(SpringfoxApplication.class, args);
 }

}

@Api(tags = "fox測試")
@RestController
@RequestMapping("/fox")
public class SpringFoxController {

 @ApiOperation("獲取fox測試")
 @GetMapping("/geTest")
 public JSONObject get(){
 JSONObject jsonObject = new JSONObject();
 jsonObject.put("id",1);
 return jsonObject;
 }
}

5. 測試