基于swagger实现测试List类型参数-创新互联

这期内容当中小编将会给大家带来有关基于swagger实现测试List类型参数，文章内容丰富且以专业的角度为大家分析和叙述，阅读完这篇文章希望大家可以有所收获。

创新互联专业为企业提供克州网站建设、克州做网站、克州网站设计、克州网站制作等企业网站建设、网页设计与制作、克州企业网站模板建站服务，十多年克州做网站经验，不只是建网站，更提供有价值的思路和整体网络服务。

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

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

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

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

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

在swagger中如果直接使用int，List 这样的参数，会导致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 idList) {...}

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

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

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

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

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

上述就是小编为大家分享的基于swagger实现测试List类型参数了，如果刚好有类似的疑惑，不妨参照上述分析进行理解。如果想知道更多相关知识，欢迎关注创新互联-成都网站建设公司行业资讯频道。

本文标题：基于swagger实现测试List类型参数-创新互联
URL地址：http://cdxtjz.cn/article/dedeoo.html