springcloud gateway聚合swagger2的方法示例
問(wèn)題描述
在搭建分布式應(yīng)用時(shí),每個(gè)應(yīng)用通過(guò)nacos在網(wǎng)關(guān)出裝配了路由,我們希望網(wǎng)關(guān)也可以將所有的應(yīng)用的swagger界面聚合起來(lái)。這樣前端開(kāi)發(fā)的時(shí)候只需要訪問(wèn)網(wǎng)關(guān)的swagger就可以,而不用訪問(wèn)每個(gè)應(yīng)用的swagger。
框架
springcloud+gateway+nacos+swagger
問(wèn)題分析
swagger頁(yè)面是一個(gè)單頁(yè)面應(yīng)用,所有的顯示的數(shù)據(jù)都是通過(guò)和springfox.documentation.swagger.web.ApiResponseController進(jìn)行數(shù)據(jù)交互,首先通過(guò)/swagger-resources獲取swagger資源信息,獲取的信息格式如下:[{name: "default", url: "/v2/api-docs", swaggerVersion: "2.0", location: "/v2/api-docs"}],其中name代表swagger生成的接口組的組名,如圖所示:
url
代表swagger接口組的詳細(xì)信息可以通過(guò) localhost:8081/v2/api-docs來(lái)獲取,如下圖:

在網(wǎng)關(guān)處,如果訪問(wèn)/swagger-resources能夠獲取到所有應(yīng)用的swagger的資源信息,那么我們的問(wèn)題就可以解決了,所以我們需要做的是修改/swagger-resources接口的處理方式,使得這個(gè)接口能夠按照我們的需求返回swagger資源。
解決方案
我們首先在網(wǎng)關(guān)處引入swagger的相關(guān)依賴(lài),然后實(shí)現(xiàn)一個(gè)獲取其他應(yīng)用的swagger資源的組件:
/**
* 聚合各個(gè)服務(wù)的swagger接口
*
* @author ksyzz
* @since <pre>2019/04/09</pre>
*/
@Component
public class MySwaggerResourceProvider implements SwaggerResourcesProvider {
/**
* swagger2默認(rèn)的url后綴
*/
private static final String SWAGGER2URL = "/v2/api-docs";
/**
* 網(wǎng)關(guān)路由
*/
private final RouteLocator routeLocator;
/**
* 網(wǎng)關(guān)應(yīng)用名稱(chēng)
*/
@Value("${spring.application.name}")
private String self;
@Autowired
public MySwaggerResourceProvider(RouteLocator routeLocator) {
this.routeLocator = routeLocator;
}
@Override
public List<SwaggerResource> get() {
List<SwaggerResource> resources = new ArrayList<>();
List<String> routeHosts = new ArrayList<>();
// 由于我的網(wǎng)關(guān)采用的是負(fù)載均衡的方式,因此我需要拿到所有應(yīng)用的serviceId
// 獲取所有可用的host:serviceId
routeLocator.getRoutes().filter(route -> route.getUri().getHost() != null)
.filter(route -> !self.equals(route.getUri().getHost()))
.subscribe(route -> routeHosts.add(route.getUri().getHost()));
// 記錄已經(jīng)添加過(guò)的server,存在同一個(gè)應(yīng)用注冊(cè)了多個(gè)服務(wù)在nacos上
Set<String> dealed = new HashSet<>();
routeHosts.forEach(instance -> {
// 拼接url,樣式為/serviceId/v2/api-info,當(dāng)網(wǎng)關(guān)調(diào)用這個(gè)接口時(shí),會(huì)自動(dòng)通過(guò)負(fù)載均衡尋找對(duì)應(yīng)的主機(jī)
String url = "/" + instance + SWAGGER2URL;
if (!dealed.contains(url)) {
dealed.add(url);
SwaggerResource swaggerResource = new SwaggerResource();
swaggerResource.setUrl(url);
swaggerResource.setName(instance);
resources.add(swaggerResource);
}
});
return resources;
}
}
然后定義一個(gè)接口類(lèi):
/**
* swagger聚合接口,三個(gè)接口都是swagger-ui.html需要訪問(wèn)的接口
*
* @author ksyzz
* @since <pre>2019/04/09</pre>
*/
@RestController
@RequestMapping("/swagger-resources")
public class SwaggerResourceController {
private MySwaggerResourceProvider swaggerResourceProvider;
@Autowired
public SwaggerResourceController(MySwaggerResourceProvider swaggerResourceProvider) {
this.swaggerResourceProvider = swaggerResourceProvider;
}
@RequestMapping(value = "/configuration/security")
public ResponseEntity<SecurityConfiguration> securityConfiguration() {
return new ResponseEntity<>(SecurityConfigurationBuilder.builder().build(), HttpStatus.OK);
}
@RequestMapping(value = "/configuration/ui")
public ResponseEntity<UiConfiguration> uiConfiguration() {
return new ResponseEntity<>(UiConfigurationBuilder.builder().build(), HttpStatus.OK);
}
@RequestMapping
public ResponseEntity<List<SwaggerResource>> swaggerResources() {
return new ResponseEntity<>(swaggerResourceProvider.get(), HttpStatus.OK);
}
}
然后啟動(dòng)網(wǎng)關(guān),訪問(wèn) http://網(wǎng)關(guān)地址/swagger-ui.html,可以看到

在箭頭處,可以切換不同應(yīng)用的swagger頁(yè)面。
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
- 詳解Spring Cloud Gateway 限流操作
- spring cloud gateway使用 uri: lb://方式配置時(shí),服務(wù)名的特殊要求
- 基于Nacos實(shí)現(xiàn)Spring Cloud Gateway實(shí)現(xiàn)動(dòng)態(tài)路由的方法
- 解決spring cloud gateway 獲取body內(nèi)容并修改的問(wèn)題
- springcloud gateway如何實(shí)現(xiàn)路由和負(fù)載均衡
- 詳解SpringCloud Gateway之過(guò)濾器GatewayFilter
- Spring Cloud Gateway全局異常處理的方法詳解
- spring cloud gateway整合sentinel實(shí)現(xiàn)網(wǎng)關(guān)限流
- Spring?Cloud?Gateway編碼實(shí)現(xiàn)任意地址跳轉(zhuǎn)
相關(guān)文章
java中fastjson生成和解析json數(shù)據(jù)(序列化和反序列化數(shù)據(jù))
本篇文章主要介紹了java中fastjson生成和解析json數(shù)據(jù)(序列化和反序列化數(shù)據(jù)),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下。2017-02-02
Spring Framework 5.0 入門(mén)教程
Spring Framework提供了一個(gè)簡(jiǎn)易的開(kāi)發(fā)方式,這種開(kāi)發(fā)方式,將避免那些可能致使底層代碼變得繁雜混亂的大量的屬性文件和幫助類(lèi)。這篇文章主要介紹了Spring Framework 5.0 入門(mén)教程,感興趣的小伙伴們可以參考一下2018-05-05
MyBatis連接池的深入和動(dòng)態(tài)SQL詳解
這篇文章主要介紹了MyBatis連接池的深入和動(dòng)態(tài)SQL詳解,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-02-02
java 實(shí)現(xiàn)圖片像素質(zhì)量壓縮與圖片長(zhǎng)寬縮放
這篇文章主要介紹了java 實(shí)現(xiàn)圖片像素質(zhì)量壓縮與圖片長(zhǎng)寬縮放,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-11-11
微服務(wù)springcloud 03.Eureka實(shí)現(xiàn)高可用的過(guò)程
這篇文章主要介紹了微服務(wù)springcloud 03.Eureka實(shí)現(xiàn)高可用的相關(guān)資料,本文給大家介紹的非常詳細(xì),需要的朋友可以參考下2024-07-07
SpringBoot集成vue的開(kāi)發(fā)解決方案
這篇文章主要介紹了SpringBoot集成vue的開(kāi)發(fā)解決方案,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-12-12
一次java異步任務(wù)的實(shí)戰(zhàn)記錄
最近做項(xiàng)目的時(shí)候遇到了一個(gè)小問(wèn)題,從前臺(tái)提交到服務(wù)端A,A調(diào)用服務(wù)端B處理超時(shí),下面這篇文章主要給大家介紹了一次java異步任務(wù)的實(shí)戰(zhàn)記錄,需要的朋友可以參考下2022-05-05

