最新下载
热门教程
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
基于swagger测试List类型参数过程解析
时间:2020-09-19 编辑:袖梨 来源:一聚教程网
本篇文章小编给大家分享一下基于swagger测试List类型参数过程解析,文章介绍的很详细,小编觉得挺不错的,现在分享给大家供大家参考,有需要的小伙伴们可以来看看。
使用swagger 时,往往会用到类似下面这样的注解
@ApiImplicitParam(name = "id", value = "主键", dataType = "int", paramType = "query")
网上说这里的dataType 类型有String / int两种,其余的都是无用的。
但是如果需要传递的参数是List类型,应该怎么办?
首先直接在浏览器中输入网址,传递参数(xxx?idList=1,2,3)来测试,是没有问题的
在swagger中如果直接使用int,List
@ApiImplicitParam(name = "idList", value = "id列表", required = true, dataType = "int", paramType = "query")
后来我的一个复杂的做法是:把List的所有值传一个String类型的参数,用中括号包起来,最后再解析。形如 xxx?idList=[1,2,3] ,可以实现效果,但是比较麻烦
再后来突然发现一个很简单的解决办法
那就是去掉@ApiImplicitParam 注解(注:我的swagger 版本是2.8.0,)
比如:
@ApiOperation("批量查询课程信息")
public Result listXxxByIdList(@RequestParam(value = "idList")
List
这样以后,测试的时候,就可以添加、删除List参数了,这个参数的类型是array[], 如下图:
可能是因为后来的swagger版本能够自动识别方法中的参数了,这样做的缺点只是没有中文描述而已
当然如果非要加上中文描述也是可以的,那就是使用 @ApiParam 注解,如下:
@ApiOperation("批量查询课程信息")
public Result listXxxByIdList(@RequestParam(value = "idList") @ApiParam(value
= "id列表") List
相关文章
- SpringBoot自定义bean绑定解析 10-24
- Javaweb工程运行报错HTTP Status 404解决教程 10-20
- JAVA获取jvm和操作系统相关信息方法 10-20
- BeanFactory和FactoryBean的区别讲解 10-20
- 微信小程序的宿主环境实现教程 10-10
- dispatchEvent解决重叠元素响应事件教程 10-10