微服务如何聚合 API 文档？这波秀~（三）

网关如何聚合Swagger？
网关聚合的思想很简单，就是从路由中获取微服务的访问地址，然后拼接上 /v2/api-docs 即可。

同样的还是要添加Swagger的两个依赖，如下：

<!--swagger-->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-boot-starter</artifactId>
</dependency>

<!--swagger-ui  这里是用了一个好看一点ui界面-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
</dependency>

创建GatewaySwaggerResourcesProvider实现SwaggerResourcesProvider，重写其中的get方法，代码如下：

 
“案例源码已上传GitHub，关注公众号：码猿技术专栏，回复关键：9528 获取！”

好了，网关的配置这里就完成了。

此时启动网关、订单、库存服务，直接访问网关的文档：http://localhost:3001/doc.html，结果如下图：

 
API文档好用的功能介绍
不得不说这款Swagger UI 界面还是比较简单易用的，个人用起来还不错。

1、搜索功能
在右上角的搜索功能可以根据接口描述搜索相关的接口信息，如下图：

 
2、离线文档
可以直接拷贝文档的MarkDown形式转换成Html或者PDF生成离线文档，如下图：

 
3、令牌配置
在访问需要认证的接口时，可以通过配置令牌，这样令牌将会全局生效，不必每个请求都要配置一遍，如下：

 
4、配置缓存
该文档的所有配置，包括请求参数、授权令牌等信息都是缓存的，也就是说配置一次，下次再打开的时候也是默认存在的。

5、全局参数配置
对于一些全局的参数，比如请求头中需要携带请求客户端、版本号等信息，可以在全局参数中配置，如下：

 
总结
本篇文章介绍了微服务集成网关聚合Swagger文档，开发中非常实用。

文章转自公众号：码猿技术专栏