SpringCloud(9) Gateway聚合Swagger文档

系统管理员 2023-01-10 10:08 133阅读 0赞

本文主要解决gateway聚合swagger文档问题  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjI1NTU4_size_16_color_FFFFFF_t_70]  
gateway服务中添加如下2个文件即可  
![在这里插入图片描述][20210123143113771.png]

> 具体代码可参考：[https://gitee.com/zhengqingya/small-tools][https_gitee.com_zhengqingya_small-tools]

@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<>();
            // 获取所有可用的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.toLowerCase() + SWAGGER2URL;
                // 无group时 使用默认
                if (!dealed.contains(url)) { 
                    dealed.add(url);
                    SwaggerResource swaggerResource = new SwaggerResource();
                    swaggerResource.setUrl(url);
                    swaggerResource.setName(instance);
                    // 服务下拉列表读取映射
                    resources.add(swaggerResource);
                }
            });
            return resources;
        }
    }

@RestController
    @RequestMapping("/swagger-resources")
    public class SwaggerHandler { 
    
        @Autowired(required = false)
        private SecurityConfiguration securityConfiguration;
    
        @Autowired(required = false)
        private UiConfiguration uiConfiguration;
    
        private final SwaggerResourcesProvider swaggerResources;
    
        @Autowired
        public SwaggerHandler(SwaggerResourcesProvider swaggerResources) { 
            this.swaggerResources = swaggerResources;
        }
    
        @GetMapping("/configuration/security")
        public Mono<ResponseEntity<SecurityConfiguration>> securityConfiguration() { 
            return Mono.just(new ResponseEntity<>(
                Optional.ofNullable(securityConfiguration).orElse(SecurityConfigurationBuilder.builder().build()),
                HttpStatus.OK));
        }
    
        @GetMapping("/configuration/ui")
        public Mono<ResponseEntity<UiConfiguration>> uiConfiguration() { 
            return Mono.just(new ResponseEntity<>(
                Optional.ofNullable(uiConfiguration).orElse(UiConfigurationBuilder.builder().build()), HttpStatus.OK));
        }
    
        @GetMapping("")
        public Mono<ResponseEntity> swaggerResources() { 
            return Mono.just((new ResponseEntity<>(swaggerResources.get(), HttpStatus.OK)));
        }
    }

--------------------

> 今日分享语句：  
> 一禅师见一蝎子掉到水里，决心救它。谁知一碰，蝎子蛰了他手指。  
> 禅师无惧，再次出手，岂知又被蝎子狠狠蛰了一次。  
> 旁有一人说：它老蜇人，何必救它？  
> 禅师答：蜇人是蝎子的天性，而善是我的天性，我岂能因为它的天性，而放弃了我的天性。  
> 感悟：我们的错误在于，因为外界的缘故而过多地改变了自己。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjI1NTU4_size_16_color_FFFFFF_t_70]: /images/20221119/4dafe63ad51b4e779c3f16b02da8a238.png
[20210123143113771.png]: /images/20221119/2a5dc448e190494c95609d42fa6af3a1.png
[https_gitee.com_zhengqingya_small-tools]: https://gitee.com/zhengqingya/small-tools