gateway网关聚合knife4j文档,同时兼容swagger2与swagger3
创始人
2024-03-06 13:03:06

基于前两篇文章,进行整合

springcloud-gateway 聚合swagger3请求接口丢失appliactionName解决

springcloud-gateway聚合knife4j接口文档

为何要兼容?微服务开发者有的使用了swagger2版本,有的使用了swagger3版本,但暴露外部给前端使用的,均统一走网关处

兼容核心点:swagger3 返回缺少bathPath

网关配置

image-20221201105700475

@Data
@ConfigurationProperties(prefix = MyGateWayProperties.PREFIX)
public class MyGateWayProperties {public static final String PREFIX = "gateway";/*** swagger3 服务列表*/private List swagger3Set;/*** 请求前缀*/private String apiPrefix;
}

请求文档的SwaggerResourcesProvider 进行调整,带上自定义网关请求前缀与 swagger文档后缀

@RestController
@RequestMapping("/swagger-resources")
public class SwaggerHandler {@Autowired(required = false)private SecurityConfiguration securityConfiguration;@Autowired(required = false)private UiConfiguration uiConfiguration;private final SwaggerResourcesProvider provider;@Autowiredpublic SwaggerHandler(SwaggerResourcesProvider provider) {this.provider = provider;}@GetMapping("/configuration/security")public Mono> securityConfiguration() {return Mono.just(new ResponseEntity<>(Optional.ofNullable(securityConfiguration).orElse(SecurityConfigurationBuilder.builder().build()),HttpStatus.OK));}@GetMapping("/configuration/ui")public Mono> uiConfiguration() {return Mono.just(new ResponseEntity<>(Optional.ofNullable(uiConfiguration).orElse(UiConfigurationBuilder.builder().build()), HttpStatus.OK));}@GetMappingpublic Mono>> swaggerResources() {return Mono.just((new ResponseEntity<>(provider.get(), HttpStatus.OK)));}
}
/*** @author lei* @create 2022-05-25 10:01* @desc 网关处获取所有服务swagger文档**/
@Slf4j
@Component
@Primary
public class SwaggerProvider implements SwaggerResourcesProvider {/*** swagger2默认的url后缀*/public static final String V3_API_DOCS = "/v3/api-docs";public static final String V2_API_DOCS = "/v2/api-docs";/*** 路由加载器*/private final RouteLocator routeLocator;private final MyGateWayProperties myGateWayProperties;/*** 网关应用名称*/@Value("${spring.application.name}")private String gateway;@Autowiredpublic SwaggerProvider(RouteLocator routeLocator, MyGateWayProperties myGateWayProperties) {this.routeLocator = routeLocator;this.myGateWayProperties = myGateWayProperties;}@Overridepublic List get() {List resources = new ArrayList<>();List routeHosts = new ArrayList<>();Flux routes = routeLocator.getRoutes();// 获取所有可用的host,因为是注册表服务调用,所以实际是服务名routes.filter(route -> route.getUri().getHost() != null).filter(route -> !gateway.equals(route.getUri().getHost())).subscribe(route -> routeHosts.add(route.getUri().getHost()));// 去重下拉列表相同服务名文档,多个服务展示一个,当网关调用这个接口时,会自动通过负载均衡寻找服务hostSet docServerSet = new HashSet<>();routeHosts.forEach(instance -> {String url;if (myGateWayProperties.getSwagger3Set().contains(instance)) {// 拼接url. /serviceId/v3/api-docsurl = myGateWayProperties.getApiPrefix() + "/" + instance.toLowerCase() + V3_API_DOCS;} else {// 拼接url. /serviceId/v2/api-docsurl = myGateWayProperties.getApiPrefix() + "/" + instance.toLowerCase() + V2_API_DOCS;}if (!docServerSet.contains(url)) {docServerSet.add(url);SwaggerResource swaggerResource = new SwaggerResource();swaggerResource.setUrl(url);swaggerResource.setName(instance);resources.add(swaggerResource);}});return resources;}
}

网关添加全局过滤器,发现以访问swagger3后缀的url则重新返回体,携带上bathPath

/*** @author lei* @create 2022-05-26 14:36* @desc swagger过滤器* 解决swagger3 响应缺少bathPath,请求无法动态路由到服务的问题**/
@Log4j2
@Component
public class SwaggerGlobalFilter implements GlobalFilter, Ordered {public static final String BASE_PATH = "basePath";private final MyGateWayProperties myGateWayProperties;public SwaggerGlobalFilter(MyGateWayProperties myGateWayProperties) {this.myGateWayProperties = myGateWayProperties;}@Overridepublic Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {String path = exchange.getRequest().getPath().toString();if (!path.endsWith(SwaggerProvider.V3_API_DOCS)) {return chain.filter(exchange);}path = path.replace(myGateWayProperties.getApiPrefix(), "");String[] pathArray = path.split("/");String basePath = pathArray[1];ServerHttpResponse originalResponse = exchange.getResponse();ServerHttpResponseDecorator newResponse = new ServerHttpResponseDecorator(originalResponse) {@Overridepublic Mono writeWith(Publisher body) {if (!Objects.equals(getStatusCode(), HttpStatus.OK)) {return super.writeWith(body);}if (body instanceof Flux) {Flux fluxBody = Flux.from(body);return super.writeWith(fluxBody.buffer().map(dataBuffers -> {List list = new ArrayList<>();dataBuffers.forEach(dataBuffer -> {byte[] content = new byte[dataBuffer.readableByteCount()];dataBuffer.read(content);DataBufferUtils.release(dataBuffer);list.add(new String(content, StandardCharsets.UTF_8));});String jsonStr = listToString(list);JSONObject jsonObject = JSON.parseObject(jsonStr);jsonObject.put(BASE_PATH, myGateWayProperties.getApiPrefix() + "/" + basePath);jsonStr = jsonObject.toString();return bufferFactory().wrap(jsonStr.getBytes());}));}return super.writeWith(body);}@Overridepublic HttpHeaders getHeaders() {HttpHeaders httpHeaders = new HttpHeaders();httpHeaders.putAll(super.getHeaders());//由于修改了请求体的body,导致content-length长度不确定,因此使用分块编码httpHeaders.remove(HttpHeaders.CONTENT_LENGTH);httpHeaders.set(HttpHeaders.TRANSFER_ENCODING, "chunked");return httpHeaders;}private String listToString(List list) {StringBuilder stringBuilder = new StringBuilder();for (String s : list) {stringBuilder.append(s);}return stringBuilder.toString();}};return chain.filter(exchange.mutate().response(newResponse).build());}@Overridepublic int getOrder() {return -2;}
}

网关获取到文档访问列表

image-20221201110418429

访问具体服务的文档,触发全局过滤器

image-20221201110720238

改写响应数据,访问swagger3文档,带上了bathPath

image-20221201110923634

image-20221201111821666

访问swagger2文档时,不受影响

image-20221201111130320

相关内容

热门资讯

猫咪吃了塑料袋怎么办 猫咪误食... 你知道吗?塑料袋放久了会长猫哦!要说猫咪对塑料袋的喜爱程度完完全全可以媲美纸箱家里只要一有塑料袋的响...
埃菲尔铁塔在哪 中国仿建埃菲尔... 2019年4月26日,广西南宁市,街头惊现一座巨型山寨版埃菲尔铁塔,高约20米,白色塔身,造型逼真,...
苗族的传统节日 贵州苗族节日有... 【岜沙苗族芦笙节】岜沙,苗语叫“分送”,距从江县城7.5公里,是世界上最崇拜树木并以树为神的枪手部落...
北京的名胜古迹 北京最著名的景... 北京从元代开始,逐渐走上帝国首都的道路,先是成为大辽朝五大首都之一的南京城,随着金灭辽,金代从海陵王...
世界上最漂亮的人 世界上最漂亮... 此前在某网上,选出了全球265万颜值姣好的女性。从这些数量庞大的女性群体中,人们投票选出了心目中最美...
应用未安装解决办法 平板应用未... ---IT小技术,每天Get一个小技能!一、前言描述苹果IPad2居然不能安装怎么办?与此IPad不...
长白山自助游攻略 吉林长白山游... 昨天介绍了西坡的景点详细请看链接:一个人的旅行,据说能看到长白山天池全凭运气,您的运气如何?今日介绍...
脚上的穴位图 脚面经络图对应的... 人体穴位作用图解大全更清晰直观的标注了各个人体穴位的作用,包括头部穴位图、胸部穴位图、背部穴位图、胳...
demo什么意思 demo版本... 618快到了,各位的小金库大概也在准备开闸放水了吧。没有小金库的,也该向老婆撒娇卖萌服个软了,一切只...
埃菲尔铁塔在哪 中国仿建埃菲尔... 2019年4月26日,广西南宁市,街头惊现一座巨型山寨版埃菲尔铁塔,高约20米,白色塔身,造型逼真,...
苗族的传统节日 贵州苗族节日有... 【岜沙苗族芦笙节】岜沙,苗语叫“分送”,距从江县城7.5公里,是世界上最崇拜树木并以树为神的枪手部落...
北京的名胜古迹 北京最著名的景... 北京从元代开始,逐渐走上帝国首都的道路,先是成为大辽朝五大首都之一的南京城,随着金灭辽,金代从海陵王...
应用未安装解决办法 平板应用未... ---IT小技术,每天Get一个小技能!一、前言描述苹果IPad2居然不能安装怎么办?与此IPad不...