feat: 升级 knife4j 到 3.0.3，统一集成到 gateway swagger

Author: cadecode

common/plugin/swagger/src/main/java/com/github/cadecode/uniboot/common/plugin/swagger/config/SwaggerAutoConfig.java

@@ -10,7 +10,6 @@
 import org.springframework.context.annotation.Import;
 import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
-import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
 
 /**
  * Swagger WebMvc 配置
@@ -19,7 +18,6 @@
  * @since 2023/6/8
  */
 @RequiredArgsConstructor
-@EnableSwagger2WebMvc
 @EnableKnife4j
 @Configuration
 @Import(SwaggerRegisterKit.class)

dependencies/pom.xml

@@ -30,7 +30,7 @@
         <guava.vsersion>31.0.1-jre</guava.vsersion>
         <vavr.vsersion>1.0.0-alpha-4</vavr.vsersion>
         <mica-auto.version>2.3.2</mica-auto.version>
-        <knife4j.version>2.0.9</knife4j.version>
+        <knife4j.version>3.0.3</knife4j.version>
         <mybatis.version>2.2.0</mybatis.version>
         <pagehelper.version>1.4.0</pagehelper.version>
         <mybatis-plus.version>3.5.1</mybatis-plus.version>

gateway/pom.xml

@@ -68,6 +68,11 @@
             <groupId>com.github.ulisesbocchio</groupId>
             <artifactId>jasypt-spring-boot-starter</artifactId>
         </dependency>
+        <!--swagger-->
+        <dependency>
+            <groupId>com.github.xiaoymin</groupId>
+            <artifactId>knife4j-spring-boot-starter</artifactId>
+        </dependency>
 
         <dependency>
             <groupId>com.github.cadecode</groupId>

gateway/src/main/java/com/github/cadecode/uniboot/gateway/config/GatewaySwaggerConfig.java

@@ -0,0 +1,72 @@
+package com.github.cadecode.uniboot.gateway.config;
+
+import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
+import lombok.RequiredArgsConstructor;
+import org.springframework.cloud.gateway.config.GatewayProperties;
+import org.springframework.cloud.gateway.route.RouteLocator;
+import org.springframework.cloud.gateway.support.NameUtils;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Primary;
+import springfox.documentation.swagger.web.SwaggerResource;
+import springfox.documentation.swagger.web.SwaggerResourcesProvider;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+/**
+ * Gateway swagger 聚合配置
+ *
+ * @author Cade Li
+ * @since 2023/7/29
+ */
+@RequiredArgsConstructor
+@EnableKnife4j
+@Configuration
+public class GatewaySwaggerConfig {
+
+    /**
+     * 网关路由
+     */
+    private final RouteLocator routeLocator;
+
+    private final GatewayProperties gatewayProperties;
+
+    @Primary
+    @Bean
+    public SwaggerResourcesProvider resourcesProvider() {
+        return new SwaggerResourcesProvider() {
+            /**
+             * 聚合服务接口
+             */
+            @Override
+            public List<SwaggerResource> get() {
+                Set<String> routeSet = new HashSet<>();
+                // 获取网关中配置的 route
+                routeLocator.getRoutes().subscribe(o -> routeSet.add(o.getId()));
+                return gatewayProperties.getRoutes().stream()
+                        .filter(o -> routeSet.contains(o.getId()))
+                        .flatMap(o -> o.getPredicates().stream()
+                                .filter(p -> "Path".equalsIgnoreCase(p.getName()))
+                                .map(p -> geneSwaggerResource(o.getId(), p.getArgs()))
+                                .collect(Collectors.toList())
+                                .stream())
+                        .collect(Collectors.toList());
+            }
+
+        };
+    }
+
+    private SwaggerResource geneSwaggerResource(String name, Map<String, String> args) {
+        // 获取 swagger2 location
+        String location = args.get(NameUtils.GENERATED_NAME_PREFIX + "0").replace("/**", "/v2/api-docs");
+        SwaggerResource swaggerResource = new SwaggerResource();
+        swaggerResource.setName(name);
+        swaggerResource.setLocation(location);
+        swaggerResource.setSwaggerVersion("2.0");
+        return swaggerResource;
+    }
+}

gateway/src/main/java/com/github/cadecode/uniboot/gateway/controller/SwaggerController.java

@@ -0,0 +1,59 @@
+package com.github.cadecode.uniboot.gateway.controller;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import reactor.core.publisher.Mono;
+import springfox.documentation.swagger.web.*;
+
+import java.util.Optional;
+
+/**
+ * Swagger 网关统一接口
+ *
+ * @author Cade Li
+ * @since 2023/7/29
+ */
+@RequiredArgsConstructor
+@RestController
+@RequestMapping("/swagger-resources")
+public class SwaggerController {
+
+    private final SwaggerResourcesProvider resourcesProvider;
+
+    private SecurityConfiguration securityConfiguration;
+
+    private UiConfiguration uiConfiguration;
+
+    @Autowired(required = false)
+    public void setSecurityConfiguration(SecurityConfiguration securityConfiguration) {
+        this.securityConfiguration = securityConfiguration;
+    }
+
+    @Autowired(required = false)
+    public void setUiConfiguration(UiConfiguration uiConfiguration) {
+        this.uiConfiguration = uiConfiguration;
+    }
+
+    @GetMapping("/configuration/security")
+    public Mono<ResponseEntity<SecurityConfiguration>> securityConfiguration() {
+        return Mono.just(new ResponseEntity<>(Optional.ofNullable(securityConfiguration)
+                .orElse(SecurityConfigurationBuilder.builder().build()), HttpStatus.OK));
+    }
+
+    @GetMapping("/configuration/ui")
+    public Mono<ResponseEntity<UiConfiguration>> uiConfiguration() {
+        return Mono.just(new ResponseEntity<>(Optional.ofNullable(uiConfiguration)
+                .orElse(UiConfigurationBuilder.builder().build()), HttpStatus.OK));
+    }
+
+    @SuppressWarnings("rawtypes")
+    @GetMapping("")
+    public Mono<ResponseEntity> swaggerResources() {
+        return Mono.just((new ResponseEntity<>(resourcesProvider.get(), HttpStatus.OK)));
+    }
+}