基于swagger测试List类型参数过程详解

使用swagger 时，往往会用到类似下面这样的注解

@ApiImplicitParam(name = "id", value = "主键", dataType = "int", paramType = "query")

网上说这里的dataType 类型有String / int两种，其余的都是无用的。

但是如果需要传递的参数是List类型，应该怎么办?

首先直接在浏览器中输入网址，传递参数（xxx?idList=1,2,3）来测试，是没有问题的

在swagger中如果直接使用int，List<Integer> 这样的参数，会导致swagger无法测试接口，如下：

@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<Long> idList) {...}

这样以后，测试的时候，就可以添加、删除List参数了，这个参数的类型是array[], 如下图：

可能是因为后来的swagger版本能够自动识别方法中的参数了，这样做的缺点只是没有中文描述而已

当然如果非要加上中文描述也是可以的，那就是使用 @ApiParam 注解，如下：

@ApiOperation("批量查询课程信息")

public Result listXxxByIdList(@RequestParam(value = "idList") @ApiParam(value = "id列表") List<Long> idList) {...}

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

最新评论