springcloud gateway聚合swagger2

問題描述

在搭建分佈式應用時，每一個應用經過nacos在網關出裝配了路由，咱們但願網關也能夠將全部的應用的swagger界面聚合起來。這樣前端開發的時候只須要訪問網關的swagger就能夠，而不用訪問每一個應用的swagger。

框架

springcloud+gateway+nacos+swagger

問題分析

swagger頁面是一個單頁面應用，全部的顯示的數據都是經過和springfox.documentation.swagger.web.ApiResponseController進行數據交互，首先經過/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來獲取，以下圖:

在網關處，若是訪問/swagger-resources可以獲取到全部應用的swagger的資源信息，那麼咱們的問題就能夠解決了，因此咱們須要作的是修改/swagger-resources接口的處理方式，使得這個接口可以按照咱們的需求返回swagger資源。

解決方案

咱們首先在網關處引入swagger的相關依賴，而後實現一個獲取其餘應用的swagger資源的組件：

/**
     * 聚合各個服務的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";
    
        /**
         * 網關路由
         */
        private final RouteLocator routeLocator;
    
        /**
         * 網關應用名稱
         */
        @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<>();
            // 因爲個人網關採用的是負載均衡的方式，所以我須要拿到全部應用的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()));
    
            // 記錄已經添加過的server，存在同一個應用註冊了多個服務在nacos上
            Set<String> dealed = new HashSet<>();
            routeHosts.forEach(instance -> {
                // 拼接url，樣式爲/serviceId/v2/api-info，當網關調用這個接口時，會自動經過負載均衡尋找對應的主機
                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);
        }
    }

而後啓動網關，訪問 http://網關地址/swagger-ui.html，能夠看到

在箭頭處，能夠切換不一樣應用的swagger頁面。