springboot快速整合swagger2(内含独家心得)

1.由来

之前用的接口文档工具是 ApiPost，很好用。最早听到Swagger，名字起的很霸气，大摇大摆的、神气十足的意思。尝试了一下，体验并不太好，所以没有继续研究。

最近接手了同事的一个项目，接口文档用的就是Swagger，没办法，躲不过去了，只好仔细研究一下。

2.步骤

• 1 导入 swagger2 的依赖；
• 2 swagger2的配置文件；
• 3 编写 swagger2 代码注释；
• 启动项目，查看生成的接口文档。

3.No Code No Say

项目github地址

说明： springboot 版本 2.1.3.RELEASE
swagger2版本：2.9.2

4.看效果

项目中swagger2有两个UI依赖，任选其一即可。

• 当使用 springfox-swagger-ui 时：
  请求地址：127.0.0.1:8080/swagger-ui.html
  效果如下：
  

• 当使用 swagger-bootstrap-ui 时：
  请求地址： 127.0.0.1:8080/doc.html
  效果如下：
  

5.关于 swagger2的API

项目中对经常用到的已经做了详细说明。

这里重点说一个地方。就是 @ApiParam 的使用。它用在方法参数上。要注意的地方是：

详情请看这里。

6. Swagger2 的本质

本质和 ApiPost、Postman一样，都是接口的说明文档。它们对参数的校验注释，并不能在项目中真的起到参数校验的效果。如果要进行参数校验，还需要另外进行。