网关如何聚合各个微服务的接口文档?

背景

在之前老顾的文章中,介绍过利用swagger实现api文档 ,我们每个微服务都有自己的一套api接口,那我们开发人员进行开发的时候,是需要打开很多api接口文档地址 ,太麻烦了,那能不能只打开一个接口地址,此地址聚合了下游服务的所有api接口文档地址

微服务Api接口配置

pom依赖包

Swagger配置

上面的配置不单单支持了接口文档,而且还只是多版本的接口文档配置,当然需要一些定制代码,看下面

接口版本

接口版本定义

配置使用

加入@ApiVersion注解就能够实现多版本了

上面的配置就是每个微服务的接口文档配置

注意如果有相关授权配置需要把相关的swagger的url地址配置成不需要授权

/doc.html,/swagger-ui.html,/webjars/,/v2/,/swagger-resources/**

网关配置

pom引入依赖包

因为Swagger暂不支持webflux项目 ,所以Gateway里不能配置SwaggerConfig ,也就是说Gateway无法提供自身API 。但一般也不会在网关项目代码里写业务API代码 。所以这里的集成只是基于WebMvc的微服务项目。

上面的代码就是把网关的路由解析出来 ,然后设置SwaggerResource;多版本的设置是基于/v2/api-docs?group=原理

配置网关路由

启动测试

访问网关地址http://localhost:8769/doc.html

总结

这样就做到了只要访问网关的api文档地址左上角进行项目接口版本切换。小伙伴有没有注意到文档的界面大有不同,就是引入了

xml 复制代码
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.3</version>
</dependency>

这个UI左右结构,非常方便,小伙伴可以自行体验一下哦。

相关推荐
xiezhr20 小时前
用户只需要知道「怎么办」,不需要知道「为什么炸了」
java·api·接口设计规范
xiezhr20 小时前
接口设计18条军规:写给那些半夜被“502”叫醒的人
java·api·restful
用户268001379191 天前
多语言采集京东商品评论,京东API(json数据返回)
api
RestCloud1 天前
SQL Server到Hive:批处理ETL性能提升30%的实战经验
数据库·api
RestCloud1 天前
为什么说零代码 ETL 是未来趋势?
数据库·api
RestCloud2 天前
跨境数据传输:ETL如何处理时区与日期格式差异
mysql·api
RestCloud2 天前
揭秘 CDC 技术:让数据库同步快人一步
数据库·api
用户268001379192 天前
Python采集tiktok视频详情数据,tiktok API系列
api
302AI3 天前
302.AI 实战指南丨将任意 API 转为 MCP Server,释放 AI 生产力
llm·api·mcp
熙客3 天前
SpringCloud概述
java·spring cloud·微服务