您好,登錄后才能下訂單哦!
問題描述
在搭建分布式應(yīng)用時,每個應(yīng)用通過nacos在網(wǎng)關(guān)出裝配了路由,我們希望網(wǎng)關(guān)也可以將所有的應(yīng)用的swagger界面聚合起來。這樣前端開發(fā)的時候只需要訪問網(wǎng)關(guān)的swagger就可以,而不用訪問每個應(yīng)用的swagger。
框架
springcloud+gateway+nacos+swagger
問題分析
swagger頁面是一個單頁面應(yīng)用,所有的顯示的數(shù)據(jù)都是通過和springfox.documentation.swagger.web.ApiResponseController進行數(shù)據(jù)交互,首先通過/swagger-resources獲取swagger資源信息,獲取的信息格式如下:[{name: "default", url: "/v2/api-docs", swaggerVersion: "2.0", location: "/v2/api-docs"}],其中name代表swagger生成的接口組的組名,如圖所示:
url
代表swagger接口組的詳細信息可以通過 localhost:8081/v2/api-docs來獲取,如下圖:
在網(wǎng)關(guān)處,如果訪問/swagger-resources能夠獲取到所有應(yīng)用的swagger的資源信息,那么我們的問題就可以解決了,所以我們需要做的是修改/swagger-resources接口的處理方式,使得這個接口能夠按照我們的需求返回swagger資源。
解決方案
我們首先在網(wǎng)關(guān)處引入swagger的相關(guān)依賴,然后實現(xiàn)一個獲取其他應(yīng)用的swagger資源的組件:
/** * 聚合各個服務(wù)的swagger接口 * * @author ksyzz * @since <pre>2019/04/09</pre> */ @Component public class MySwaggerResourceProvider implements SwaggerResourcesProvider { /** * swagger2默認的url后綴 */ private static final String SWAGGER2URL = "/v2/api-docs"; /** * 網(wǎng)關(guān)路由 */ private final RouteLocator routeLocator; /** * 網(wǎng)關(guān)應(yī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)采用的是負載均衡的方式,因此我需要拿到所有應(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)添加過的server,存在同一個應(yīng)用注冊了多個服務(wù)在nacos上 Set<String> dealed = new HashSet<>(); routeHosts.forEach(instance -> { // 拼接url,樣式為/serviceId/v2/api-info,當網(wǎng)關(guān)調(diào)用這個接口時,會自動通過負載均衡尋找對應(yīng)的主機 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; } }
然后定義一個接口類:
/** * swagger聚合接口,三個接口都是swagger-ui.html需要訪問的接口 * * @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); } }
然后啟動網(wǎng)關(guān),訪問 http://網(wǎng)關(guān)地址/swagger-ui.html,可以看到
在箭頭處,可以切換不同應(yīng)用的swagger頁面。
以上就是本文的全部內(nèi)容,希望對大家的學習有所幫助,也希望大家多多支持億速云。
免責聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。