Spring Boot-集成Swagger

二、Swagger介绍

2.1一句话介绍 Swagger

2.2 Swagger特点

三、SpringBoot集成Swagger

四、配置Swagger API信息

五、配置Swagger自定义扫描接口

5.1 默认状态

5.2 配置扫描接口

5.3 配置接口扫描过滤

六、配置Swagger开关

6.1 enable

6.2 动态配置开关

七、 配置API分组

7.1 设置默认组名

7.2  配置多个组

八、实体配置

8.1 搭建实体

8.2 常用注解

8.2.1实体类注解

8.2.2 接口注解

8.3 常用注解

九、测试Swagger的使用

9.1 测试传参

这样的话就只有Post了。

9.2 传实体类参数

9.3 错误测试

十、拓展：其他皮肤

10.1 默认

10.2 bootstrap-ui

10.3 Layui-ui

10.4 mg-ui

结语

---

一、背景

====

无论是前端还是后端开发，都或多或少地被接口文档折磨过。

（1）前端经常抱怨后端给的接口文档与实际情况不一致。

（2）后端又觉得编写及维护接口文档会耗费不少精力，经常来不及更新。

其实无论是前端调用后端，还是后端调用后端，都期望有一个好的接口文档。但是这个接口文档对于程序员来说，就跟注释一样，经常会抱怨别人写的代码没有写注释，然而自己写起代码起来，最讨厌的，也是写注释。所以仅仅只通过强制来规范大家是不够的，随着时间推移，版本迭代，接口文档往往很容易就跟不上代码了。

二、Swagger介绍

===========

发现了痛点就要去找解决方案。解决方案用的人多了，就成了标准的规范，这就是Swagger的由来。

我们只需要按照它的规范去定义接口及接口相关的信息。再通过Swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，生成多种语言的客户端和服务端的代码，以及在线接口调试页面等等。

2.1一句话介绍 Swagger

---

Swagger是一个接口文档生成工具，同时提供接口测试调用的辅助功能。

2.2 Swagger特点

---

• 号称世界上最流行的API框架

• Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新

• 直接运行，在线测试API

• 支持多种语言 （如：Java，PHP等）

• 官网：https://swagger.io/

三、SpringBoot集成Swagger

=====================

注意：使用JDK1.8+

搭建步骤：

1.新建一个SpringBoot-web项目

2.添加Maven依赖

springfox-swagger2

io.springfox

springfox-swagger2

2.9.2

springfox-swagger-ui

io.springfox

springfox-swagger-ui

2.9.2

3.编写Controller测试是否能正常运行

@RestController

public class MyController {

@RequestMapping(“/test”)

public String test(){

return “hello”;

}

}

浏览器：

正常运行！

4.使用Swagger，需要编写一个配置类-SwaggerConfig来配置 Swagger

@Configuration //配置类

@EnableSwagger2// 开启Swagger2的自动配置

public class SwaggerConfig {

}

5.测试进入Sawgger页面

重启主程序，访问 localhost:8080/swagger-ui.html

发现启动报错：

原因：是因为我们的SpringBoot版本过高

org.springframework.boot

spring-boot-starter-parent

2.6.2

将其版本降低即可，改为2.5.4

org.springframework.boot

spring-boot-starter-parent

2.5.4

我们重启主程序，访问 localhost:8080/swagger-ui.html

出现以下页面说明访问成功了。

这个界面是Swagger为我们提供的ui界面，我们可以在源码中找到它