【微服务】springboot整合swagger多种模式使用详解

目录

一、前言

1.1 编写API文档

1.2 使用一些在线调试工具

1.3 postman

1.4 swagger

二、swagger简介

2.1 背景

2.2 swagger优缺点

2.2.1 swagger优点

2.2.2 swagger缺点

2.2.3 swagger使用场景

三、swagger常用的几种整合模式

3.1 swagger2

3.2 knife4j

3.2.1 knife4j特点

3.2.2 knife4j版本说明

3.3 Springdoc

3.3.1 SpringDoc简介

四、springboot整合swagger多种模式案例

4.1 springboot整合swagger2

4.1.1 添加如下核心依赖

4.1.2 配置文件

4.1.3 自定义swagger配置类

4.1.4 自定义测试接口

4.1.5 自定义实体类

4.1.6 访问swagger界面

4.2 springboot整合knife4j

4.2.1 引入核心依赖

4.2.2 自定义配置类

4.2.3 添加测试接口

4.2.4 自定义实体类

4.2.5 访问UI界面

4.3 springboot整合springdoc

4.3.1 添加核心依赖

4.3.2 核心配置文件

4.3.3 自定义配置类

4.3.4 自定义测试接口

4.3.5 访问UI界面

五、写在结尾

---

一、前言

在如今迭代速度越来越快的开发模式下，使用springboot作为服务端框架进行开发的项目越来越多，当后端API开发并自测完成后，如何能让前端同事与你快速高效的对接API呢？可能大家知道的有下面几种方式：

1.1 编写API文档

这是很多公司比较传统的做法，一般来说，这种方式对API开发者有着较高的要求，因为文档的编写过程相对耗时，所以API在开发之前，需要对API的各项参数进行严格的评审，以便减少在对接过程中的改动带来的事件成本。文档可以使用传统的word文档，或者使用markdown编辑。

1.2 使用一些在线调试工具

如今市面上出现了很多在线接口调试工具，只需要将你的API服务部署到服务器，然后就可以在线远程调试了。

<