今天这篇文章介绍一下微服务如何聚合Swagger实现接口文档管理。
文章目录如下:
为什么需要聚合?
微服务模块众多,如果不聚合文档,则访问每个服务的API文档都需要单独访问一个Swagger UI界面,这么做客户端能否接受?
反正作为强迫症的我是接受不了.......
既然使用了微服务,就应该有统一的API文档入口。
如何聚合?
统一的文档入口显然应该聚合到网关中,通过网关的入口统一映射到各个模块。
本文采用Spring Cloud Gateway 聚合 Swagger 的 方式 生成API文档。
案例源码结构如下:
本文只介绍如何聚合Swagger,关于网关、注册中心等内容不再介绍,有不了解的看陈某前面文章。
单个服务如何聚合Swagger?
这里的单个服务不包括网关,网关需要单独配置。
单个服务聚合其实很简单,就是普通的Spring Boot 整合 Swagger,但是微服务模块众多,不能每个微服都整合一番,因此可以自定义一个swagger-starter,之后每个微服务都依赖这个starter即可。
详细的步骤如下:
1、创建swagger-starter
自定义starter这里就不再介绍了,都是基础的知识;
目录结构如下: