swagger实现多项目api管理

最新推荐文章于 2024-07-26 09:36:54 发布

liufei198613

最新推荐文章于 2024-07-26 09:36:54 发布

阅读量1.2w

点赞数 1

分类专栏： swagger

本文链接：https://blog.csdn.net/liufei198613/article/details/78898789

版权

本文介绍了如何利用Swagger解决微服务拆分后API管理不便的问题。通过修改Swagger UI的源码，添加一个下拉框展示不同服务的名称和地址，实现一键切换查看各项目API。首先下载Swagger UI的2.2.10版本源码，然后在HTML目录下创建urlData.json存储服务信息。接着处理Springfox的API路径，通过配置application.yml和SwaggerConfigure.java，实现多项目API的无缝浏览。最后分享了改造后的项目下载链接。

摘要由CSDN通过智能技术生成

公司最近在做微服务拆分，将一个项目拆分成多个小的服务，拆分之后，项目多了，不同的项目的api也随之增多，各个独立，很难管理。同时前端同学开发的时候，要不停的找项目api地址，很不方便。我们项目api的接口管理用的是swagger,于是有了一个想法，swagger可不可以支持多项目呢。看了一下页面结构，他有一个api-docs地址的输入框，可以输入地址，再点浏览，就可以查看对应地址的api。那么其实我只要在输入框前面加一个下拉框，里面有对应的服务的名称及地址，当我选择不同的服务时，输入框内会被填充成对应的服务的api地址，即可实现我们的目标。

首先我们要下载swagger-ui的源码，这里下载的是2.2.10的版本，因为我们项目使用的是srpingfox2.6.1,还有一个重要的原因是swagger3.x是用react实现的，我不会（感叹年逝去，已经落后了），下载地址是https://github.com/swagger-api/swagger-ui/tree/v2.2.10，项目是用nodejs来编译的，所以要先配好nodejs的环境。

代码下载后，开始改造代码，其实改动很简单，我们首先要有一个地方存服务名及地址的一些信息，因为服务的名称还有地址不会改动太大，所以想到直接放在json里，于是要在html目录下新建一个urlData.json的文件用于存储相关数据。

urlData.json