问题描述
在搭建分布式应用时，每个应用通过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页面。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持亿速云。
免责声明：本站发布的内容（图片、视频和文字）以原创、转载和分享为主，文章观点不代表本网站立场，如果涉及侵权请联系站长邮箱：is@yisu.com进行举报，并提供相关证据，一经查实，将立刻删除涉嫌侵权内容。
