网上SpringCoud Gateway聚合Swagger的教程其实已经有很多了,实现也是相对比较简单的,但在真实的日常工作中可能会遇到的问题不仅仅只有如此,其很多地方要根据不同的需求场景有待我们深入了解并解决(出入口网关,源服务应用都是Gateway框架,gateway聚合gateway swagger)。
在现实工作中,一个域名可能不仅仅只包含了一个系统功能,更有可能的是会根据不同的上下文根来区分不同的功能,就像在接入出入口网关的时候,我们需要为其添加相应的上下文根来表示其为出入口网关,如 /gateway。
在SpringCloud Gateway上配置路由的时候,我们可以根据过滤器StripPrefix=2来动态添加上下文根。这里demo服务应用本身也采用了Gateway框架
spring:
cloud:
gateway:
#路由配置
routes:
- id: demoSwagger
uri: lb://DEMO-CLIENT2
predicates:
- Path=/gateway/demo/**
filters:
- StripPrefix=2
其中/gateway表示网关上下文根, /demo表示其路由应用服务路径
接口测试调用/gateway/demo/test时 正常
在SpringCloud Gateway聚合Swagger的时候 ,其页面显示也是正常的
但是在使用swagger进行真实调用的时候 /gateway 上下文丢失了,造成了调用报Undocumented TypeError: Failed to fetch,调用地址显示的是源服务ip地址,真实生产我们也不可能暴露ip端口给外部调用,其通过swagger页面这样调用本身也有跨域问题。
原来SpringCloud Gateway本身并不支持ContextPath上下文配置,只能通过路由配置的(或者过滤器)方式来实现上下文,但是swagger是通过扫描Controller来实现接口文档显示组合的,在这种情况上swagger所收集到的请求路径都是缺少上下文的
Host:默认为服务ip端口
basePath:/
分析原因,开始逐步定位。Swagger2ControllerWebFlux会暴露/v2/api-docs接口,gateway在聚合时会调用源服务swagger接口地址去获取其swagger聚合数据。在其接口设置断点,我们可以发现其Swagger Host BasePath都是不符合要求的。
进行定位执行,我们发现Swagger还提供了WebFluxSwaggerTransformationFilter过滤器List,我们尝试添加自定义过滤器,组合获取我们需要的Host BasePath进行修改。其默认实现的过滤WebFluxBasePathAndHostnameTransformationFilter 并不能获取到Host BasePath。
在源服务上自定义该过滤器CustomWebFluxSwaggerTransformationFilter,其请求头X-Forwarded-Prefix对应路由上下文,X-Forwarded-Host为聚合Gateway域名地址
@Component
@Primary
public class CustomWebFluxSwaggerTransformationFilter implements WebFluxSwaggerTransformationFilter {
@Override
public Swagger transform(SwaggerTransformationContext<ServerHttpRequest> context) {
Swagger swagger = context.getSpecification();
context.request().ifPresent(request -> {
HttpHeaders headers = request.getHeaders();
String basePath = headers.getFirst("X-Forwarded-Prefix");
if(StringUtils.hasText(basePath)){
swagger.basePath(basePath);
}else{
swagger.basePath("/");
}
String hostHeader = headers.getFirst("X-Forwarded-Host");
if (StringUtils.hasText(hostHeader)) {
swagger.host(StringUtils.tokenizeToStringArray(hostHeader, ",")[0]);
}
});
return swagger;
}
@Override
public boolean supports(DocumentationType delimiter) {
return delimiter == DocumentationType.SWAGGER_2;
}
}
最后,我们测试验证都正常了,使用了域名+basePath路由方式调用了