背景

在前后端分离开发中，为了减少与其它团队的沟通成本，一般都会构建一份 RESTful API 文档来描述所有的接口信息。但传统的方式有许多弊端，不仅编写文档工作量巨大，而且维护不方便，测试也不方便（需要借助第三方工具，如 Postman 来测试）

为解决这些问题，我们可以使用 Swagger 2 来构建在线接口文档，把代码和文档融为一体，减少人工维护文档的成本

目标

学习在Springboot项目中集成Swagger在线文档

内容

安装配置

1. 首先编辑项目的 pom.xml 文件，添加 Swagger 2 相关依赖

2.创建 Swagger 2 的配置类，代码如下

使用示例

1. 首先我们在 Controller 上添加相关的 @Api 注解

（1）@Api 注解标注在类上用来描述整个 Controller 信息。
（2）@ApiOperation 注解标注在方法上，用来描述一个方法的基本信息。
（3）@ApiImplicitParam 注解标注在方法上，用来描述方法的参数。其中 paramType 是指方法参数的类型，有如下可选值：

• path：参数获取方式为 @PathVariable

• query：参数获取方式为 @RequestParam

• header：参数获取方式为 @RequestHeader

• body

• form

（4）如果有多个参数，可以将多个参数的 @ApiImplicitParam 注解放到 @ApiImplicitParams 中。
（5）@ApiResponse 是对响应结果的描述。code 表示响应码，message 为相应的描述信息。如果有多个 @ApiResponse，则放在一个 @ApiResponses 中。
（6）@ApiIgnore 注解表示不对某个接口生成文档。

2.对模型对象也添加相关的注解

查看接口文档

1. 启动 Spring Boot 项目，在浏览器中输入 http://localhost:8080/swagger-ui.html 即可看到接口文档

2.点击任一接口，可以进行测试