GateWay整合swagger

GateWay整合knife4j

参考文档：https://doc.xiaominfo.com/docs/action/springcloud-gateway

pom.xml配置依赖

<dependencies>
    <!--注册中心客户端-->
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    <!--服务实例负载均衡-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-loadbalancer</artifactId>
    </dependency>
    <!--bootstrap.xml支持-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-bootstrap</artifactId>
    </dependency>
    <!--nacos作为配置中心-->
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    </dependency>
    <!--gateway网关-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
    <!--knife4j-->
    <dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>knife4j-spring-boot-starter</artifactId>
    </dependency>
</dependencies>

GateWay整合knife4j的配置

@Component
@Primary
public class SwaggerResourceConfig implements SwaggerResourcesProvider {

   private static final Logger log = LoggerFactory.getLogger(SwaggerResourceConfig.class);

   private final RouteLocator routeLocator;

   private final GatewayProperties gatewayProperties;

   public SwaggerResourceConfig(RouteLocator routeLocator, GatewayProperties gatewayProperties) {
      this.routeLocator = routeLocator;
      this.gatewayProperties = gatewayProperties;
   }

   @Override
   public List<SwaggerResource> get() {
      List<SwaggerResource> resources = new ArrayList<>();
      List<String> routes = new ArrayList<>();
      // Flux装着路由的信息，这里相当于遍历取出这些配置的路由信息服务名（route.getId）
      routeLocator.getRoutes().subscribe(route -> routes.add(route.getId()));
      for (RouteDefinition routeDefinition : gatewayProperties.getRoutes()) {
         if (routes.contains(routeDefinition.getId())) {
            // 取出当前路由的断言
            for (PredicateDefinition predicateDefinition : routeDefinition.getPredicates()) {
               if (("Path").equalsIgnoreCase(predicateDefinition.getName())) {
                  resources
                        .add(swaggerResource(routeDefinition.getId(), predicateDefinition.getArgs()
                              // 对于Path的断言，可能不止一个，这里只取出第一个，所以配置文件第一个路由断言最好写服务名
                              .get(NameUtils.GENERATED_NAME_PREFIX + "0").replace("**", "v2/api-docs")));
               }
            }
         }
      }

      return resources;
   }

   private SwaggerResource swaggerResource(String name, String location) {
      log.info("name:{},location:{}", name, location);
      SwaggerResource swaggerResource = new SwaggerResource();
      swaggerResource.setName(name);
      swaggerResource.setLocation(location);
      swaggerResource.setSwaggerVersion("2.0");
      return swaggerResource;
   }

}

knife4j发的请求

@RestController
public class SwaggerHandler {

   @Autowired(required = false)
   private SecurityConfiguration securityConfiguration;

   @Autowired(required = false)
   private UiConfiguration uiConfiguration;

   private final SwaggerResourcesProvider swaggerResources;

   @Autowired
   public SwaggerHandler(SwaggerResourcesProvider swaggerResources) {
      this.swaggerResources = swaggerResources;
   }


   @GetMapping("/swagger-resources/configuration/security")
   public Mono<ResponseEntity<SecurityConfiguration>> securityConfiguration() {
      return Mono.just(new ResponseEntity<>(
            Optional.ofNullable(securityConfiguration).orElse(SecurityConfigurationBuilder.builder().build()), HttpStatus.OK));
   }

   @GetMapping("/swagger-resources/configuration/ui")
   public Mono<ResponseEntity<UiConfiguration>> uiConfiguration() {
      return Mono.just(new ResponseEntity<>(
            Optional.ofNullable(uiConfiguration).orElse(UiConfigurationBuilder.builder().build()), HttpStatus.OK));
   }

   @GetMapping("/swagger-resources")
   public Mono<ResponseEntity> swaggerResources() {
      return Mono.just((new ResponseEntity<>(swaggerResources.get(), HttpStatus.OK)));
   }

}