本文介绍了SpringBoot如何与Swagger整合，用于生成API文档并方便测试。Swagger注解如@Api, @ApiOperation, @ApiImplicitParams等用于描述Controller和参数。通过Swagger，接口修改后能自动更新，简化前后端分离的开发流程。文章还提到了Swagger响应码含义及整合过程中遇到的问题和解决方案。"
76757611,6675007,使用ArcPy将.mxd转换为.sddraft,"['arcgis', 'arcgis server']
Swagger主要是用于前后端分离开发的时候，快速方便的输出API文档。
并且，为了方便进行测试后台的restful形式的接口，实现动态的更新，当我们在后台的接口修改了后，swagger可以实现自动的更新，而不需要认为的维护这个接口进行测试。
优点
- 前后端分离开发
- API文档非常明确
- 测试的时候不需要再使用URL输入浏览器的方式来访问Controller
- 传统的输入URL的测试方式对于post请求的传参比较麻烦（当然，可以使用postman这样的浏览器插件）
- spring-boot与swagger的集成灰常简单
注解
- @Api，是标注一个Controller（Class）为一个swagger资源（API）。
- @ApiOperation,对一个操作或HTTP方法进行描述
- @ApiImplicitParams：用在方法上包含一组参数说明
- @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
- paramType：参数放在哪个地方
- header–>请求参数的获取：@RequestHeader
- query–>请求参数的获取：@RequestParam
- path（用于restful接口）–>请求参数的获取：@PathVariable
- body（不常用）
- form（不常用）
- name：参数名
- dataType：参数类型
- required：参数是否必须传
- value：参数的意思
- defaultValue：参数的默认值
- @ApiResponses：用于表示一组响应
最低0.47元/天 解锁文章
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
