1、能够自动展示接口,轻松整合到springboot中,减少创建文档的工作量,让维护文档和代码整合一体
2、可以测试每个RestFul API
效果图
一、添加依赖
io.springfox--->springboot-swagger2
io.springfox--->springboot-swagger-ui
二、添加配置类
类Swagger2需要和项目的Application在同一级目录下,如下图
配置类如下:
三、为api添加说明
为方法添加@ApiOperation
为参数添加@ApiImplicitParm
如果有多个参数使用@ApiImplicitParams({
@ApiImplicitParam(*****),
@ApiImplicitParam(*****),
})
注意,在配置参数的说明时,有多个参数,其中paramType,包含五个分为body,path,form,header,query,具体的作用查看官网说明,后续补充。
四、测试和使用
调用项目对应接口下的swagger-ui.html页面
http://localhost:8081/swagger-ui.html
网友评论