SpringBoot（七）：SpringBoot整合Swagger2

 原文地址：https://blog.csdn.net/saytime/article/details/74937664

手写Api文档的几个痛点：

1. 文档须要更新的时候，须要再次发送一份给前端，也就是文档更新交流不及时。
2. 接口返回结果不明确
3. 不能直接在线测试接口，一般须要使用工具，好比postman
4. 接口文档太多，很差管理

Swagger也就是为了解决这个问题，固然也不能说Swagger就必定是完美的，固然也有缺点，最明显的就是代码移入性比较强。

其余的很少说，想要了解Swagger的，能够去Swagger官网，能够直接使用Swagger editor编写接口文档，固然咱们这里讲解的是SpringBoot整合Swagger2，直接生成接口文档的方式。

1、依赖

2、Swagger配置类

其实这个配置类，只要了解具体能配置哪些东西就行了，毕竟这个东西配置一次以后就不用再动了。 特别要注意的是里面配置了api文件也就是controller包的路径，否则生成的文档扫描不到接口。

Application.class 加上注解@EnableSwagger2 表示开启Swagger

3、Restful 接口

Json格式输出类 JsonResult.class

实体User.class

项目结构：

4、Swagger2文档

启动SpringBoot项目，访问 http://localhost:8080/swagger-ui.html

具体里面的内容以及接口测试，应该一看就懂了。这里就不一一截图了。

5、Swagger注解

swagger经过注解代表该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。

• @Api：修饰整个类，描述Controller的做用
• @ApiOperation：描述一个类的一个方法，或者说一个接口
• @ApiParam：单个参数描述
• @ApiModel：用对象来接收参数
• @ApiProperty：用对象接收参数时，描述对象的一个字段
• @ApiResponse：HTTP响应其中1个描述
• @ApiResponses：HTTP响应总体描述
• @ApiIgnore：使用该注解忽略这个API
• @ApiError ：发生错误返回的信息
• @ApiImplicitParam：一个请求参数
• @ApiImplicitParams：多个请求参数