gateway集成Knife4j
This commit is contained in:
parent
3e8b2d7d58
commit
6005c4839b
@ -1,7 +1,7 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
<parent>
|
<parent>
|
||||||
<artifactId>yudao</artifactId>
|
<artifactId>yudao</artifactId>
|
||||||
<groupId>cn.iocoder.cloud</groupId>
|
<groupId>cn.iocoder.cloud</groupId>
|
||||||
@ -62,8 +62,23 @@
|
|||||||
<groupId>cn.iocoder.cloud</groupId>
|
<groupId>cn.iocoder.cloud</groupId>
|
||||||
<artifactId>yudao-spring-boot-starter-monitor</artifactId>
|
<artifactId>yudao-spring-boot-starter-monitor</artifactId>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.github.xiaoymin</groupId>
|
||||||
|
<artifactId>knife4j-spring-boot-starter</artifactId>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>io.swagger</groupId>
|
||||||
|
<artifactId>swagger-annotations</artifactId>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>io.springfox</groupId>
|
||||||
|
<artifactId>springfox-boot-starter</artifactId>
|
||||||
|
<version>3.0.0</version>
|
||||||
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
|
|
||||||
|
|
||||||
<build>
|
<build>
|
||||||
<!-- 设置构建的 jar 包名 -->
|
<!-- 设置构建的 jar 包名 -->
|
||||||
<finalName>${project.artifactId}</finalName>
|
<finalName>${project.artifactId}</finalName>
|
||||||
|
@ -0,0 +1,63 @@
|
|||||||
|
package cn.iocoder.yudao.gateway.swagger;
|
||||||
|
|
||||||
|
|
||||||
|
import java.util.Optional;
|
||||||
|
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.SecurityConfiguration;
|
||||||
|
import springfox.documentation.swagger.web.SecurityConfigurationBuilder;
|
||||||
|
import springfox.documentation.swagger.web.SwaggerResourcesProvider;
|
||||||
|
import springfox.documentation.swagger.web.UiConfiguration;
|
||||||
|
import springfox.documentation.swagger.web.UiConfigurationBuilder;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @author zxliu
|
||||||
|
* @create 2022-10-25 11:24
|
||||||
|
*/
|
||||||
|
|
||||||
|
@RestController
|
||||||
|
@RequestMapping("/swagger-resources")
|
||||||
|
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("/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<>(swaggerResources.get(), HttpStatus.OK)));
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@ -0,0 +1,53 @@
|
|||||||
|
package cn.iocoder.yudao.gateway.swagger;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.List;
|
||||||
|
import lombok.AllArgsConstructor;
|
||||||
|
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.Primary;
|
||||||
|
import org.springframework.stereotype.Component;
|
||||||
|
import springfox.documentation.swagger.web.SwaggerResource;
|
||||||
|
import springfox.documentation.swagger.web.SwaggerResourcesProvider;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @author zxliu
|
||||||
|
* @create 2022-10-25 11:23
|
||||||
|
*/
|
||||||
|
|
||||||
|
@Component
|
||||||
|
@Primary
|
||||||
|
@AllArgsConstructor
|
||||||
|
public class SwaggerProvider implements SwaggerResourcesProvider {
|
||||||
|
|
||||||
|
private final RouteLocator routeLocator;
|
||||||
|
private final GatewayProperties gatewayProperties;
|
||||||
|
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<SwaggerResource> get() {
|
||||||
|
List<SwaggerResource> resources = new ArrayList<>();
|
||||||
|
List<String> routes = new ArrayList<>();
|
||||||
|
routeLocator.getRoutes().subscribe(route -> routes.add(route.getId()));
|
||||||
|
gatewayProperties.getRoutes().stream().filter(routeDefinition -> routes.contains(routeDefinition.getId()))
|
||||||
|
.forEach(route -> route.getPredicates().stream()
|
||||||
|
.filter(predicateDefinition -> ("Path").equalsIgnoreCase(predicateDefinition.getName()))
|
||||||
|
.forEach(predicateDefinition -> resources.add(swaggerResource(route.getId(),
|
||||||
|
predicateDefinition.getArgs().get(NameUtils.GENERATED_NAME_PREFIX + "0")
|
||||||
|
.replace("**", "v2/api-docs"))))
|
||||||
|
);
|
||||||
|
|
||||||
|
return resources;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
private SwaggerResource swaggerResource(String name, String location) {
|
||||||
|
SwaggerResource swaggerResource = new SwaggerResource();
|
||||||
|
swaggerResource.setName(name);
|
||||||
|
swaggerResource.setLocation(location);
|
||||||
|
swaggerResource.setSwaggerVersion("2.0");
|
||||||
|
return swaggerResource;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@ -5,25 +5,41 @@ spring:
|
|||||||
cloud:
|
cloud:
|
||||||
# Spring Cloud Gateway 配置项,对应 GatewayProperties 类
|
# Spring Cloud Gateway 配置项,对应 GatewayProperties 类
|
||||||
gateway:
|
gateway:
|
||||||
|
discovery:
|
||||||
|
locator:
|
||||||
|
# gateway开启服务注册和发现的功能,
|
||||||
|
enabled: true
|
||||||
|
# 将请求路径上的服务名配置为小写(因为服务注册的时候,向注册中心注册时将服务名转成大写的了)
|
||||||
|
lowerCaseServiceId: true
|
||||||
# 路由配置项,对应 RouteDefinition 数组
|
# 路由配置项,对应 RouteDefinition 数组
|
||||||
routes:
|
routes:
|
||||||
- id: system-admin-api # 路由的编号
|
- id: system-admin-api # 路由的编号
|
||||||
uri: grayLb://system-server
|
uri: grayLb://system-server
|
||||||
predicates: # 断言,作为路由的匹配条件,对应 RouteDefinition 数组
|
predicates: # 断言,作为路由的匹配条件,对应 RouteDefinition 数组
|
||||||
- Path=/admin-api/system/**
|
- Path=/admin-api/system/**
|
||||||
|
filters:
|
||||||
|
- RewritePath=/admin-api/system/v2/api-docs, /v2/api-docs
|
||||||
- id: system-app-api # 路由的编号
|
- id: system-app-api # 路由的编号
|
||||||
uri: grayLb://system-server
|
uri: grayLb://system-server
|
||||||
predicates: # 断言,作为路由的匹配条件,对应 RouteDefinition 数组
|
predicates: # 断言,作为路由的匹配条件,对应 RouteDefinition 数组
|
||||||
- Path=/app-api/system/**
|
- Path=/app-api/system/**
|
||||||
|
filters:
|
||||||
|
- RewritePath=/app-api/system/v2/api-docs, /v2/api-docs
|
||||||
- id: infra-admin-api # 路由的编号
|
- id: infra-admin-api # 路由的编号
|
||||||
uri: grayLb://infra-server
|
uri: grayLb://infra-server
|
||||||
predicates: # 断言,作为路由的匹配条件,对应 RouteDefinition 数组
|
predicates: # 断言,作为路由的匹配条件,对应 RouteDefinition 数组
|
||||||
- Path=/admin-api/infra/**
|
- Path=/admin-api/infra/**
|
||||||
|
filters:
|
||||||
|
- RewritePath=/admin-api/infram/v2/api-docs, /v2/api-docs
|
||||||
- id: infra-app-api # 路由的编号
|
- id: infra-app-api # 路由的编号
|
||||||
uri: grayLb://infra-server
|
uri: grayLb://infra-server
|
||||||
predicates: # 断言,作为路由的匹配条件,对应 RouteDefinition 数组
|
predicates: # 断言,作为路由的匹配条件,对应 RouteDefinition 数组
|
||||||
- Path=/app-api/infra/**
|
- Path=/app-api/infra/**
|
||||||
|
filters:
|
||||||
|
- RewritePath=/app-api/infra/v2/api-docs, /v2/api-docs
|
||||||
- id: bpm-admin-api # 路由的编号
|
- id: bpm-admin-api # 路由的编号
|
||||||
uri: grayLb://bpm-server
|
uri: grayLb://bpm-server
|
||||||
predicates: # 断言,作为路由的匹配条件,对应 RouteDefinition 数组
|
predicates: # 断言,作为路由的匹配条件,对应 RouteDefinition 数组
|
||||||
- Path=/admin-api/bpm/**
|
- Path=/admin-api/bpm/**
|
||||||
|
filters:
|
||||||
|
- RewritePath=/admin-api/bpm/v2/api-docs, /v2/api-docs
|
||||||
|
Loading…
Reference in New Issue
Block a user