您的位置：首页 > 编程技术 > java  >  基于swagger测试List类型参数过程详解

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

 更新时间：2020年9月19日 20:41  点击：2049

使用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) {...}

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

[!--infotagslink--]

相关文章

  • Java8 实现stream将对象集合list中抽取属性集合转化为map或list

    这篇文章主要介绍了Java8 实现stream将对象集合list中抽取属性集合转化为map或list的操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2021-02-05

  • java8如何用Stream查List对象某属性是否有重复

    这篇文章主要介绍了java8如何用Stream查List对象某属性是否有重复的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教...2021-09-11

  • 在java中获取List集合中最大的日期时间操作

    这篇文章主要介绍了在java中获取List集合中最大的日期时间操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2020-08-15

  • C#中list用法实例

    这篇文章主要介绍了C#中list用法,结合实例形式分析了C#中list排序、运算、转换等常见操作技巧,具有一定参考借鉴价值,需要的朋友可以参考下...2020-06-25

  • Swagger中@ApiIgnore注解的使用详解

    这篇文章主要介绍了Swagger中@ApiIgnore注解的使用，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教...2021-10-21

  • Java8处理List的双层循环问题

    这篇文章主要介绍了Java8处理List的双层循环问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2020-08-19

  • Nest.js参数校验和自定义返回数据格式详解

    这篇文章主要给大家介绍了关于Nest.js参数校验和自定义返回数据格式的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2021-03-28

  • C# List 排序各种用法与比较

    这篇文章主要介绍了C# List 排序各种用法与比较的相关资料,需要的朋友可以参考下...2020-06-25

  • Vue 组件复用多次自定义参数操作

    这篇文章主要介绍了Vue 组件复用多次自定义参数操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2020-07-27

  • 使用list stream: 任意对象List拼接字符串

    这篇文章主要介绍了使用list stream:任意对象List拼接字符串操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教...2021-09-09

  • 解决Springboot get请求是参数过长的情况

    这篇文章主要介绍了解决Springboot get请求是参数过长的情况，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2020-09-17

  • PHP中empty和isset对于参数结构的判断及empty()和isset()的区别

    废话不多说了，直接给大家贴代码了。<&#63;php class test{} $a1 = null; $a2 = ""; //$a3 = $a4 = 0; $a5 = '0'; $a6 = false; $a7 = array(); //var $a8; $a9 = new test(); for ($i=1; $i <=9 ; $i++) {...2015-11-24

  • java正则表达式判断前端参数修改表中另一个字段的值

    这篇文章主要介绍了java正则表达式判断前端参数修改表中另一个字段的值,需要的朋友可以参考下...2021-05-07

  • mysql配置模板(my-*.cnf)参数详细说明

    mysql安装成功后有几个默认的配置模板，列表如下： my-huge.cnf ： 用于高端产品服务器，包括1到2GB RAM,主要运行mysql my-innodb-heavy-4G.ini ： 用于只有innodb的安装，最多有4GB RAM，支持大的查询和低流量 my-large.cnf ： 用于...2015-03-15

  • 详解C#泛型的类型参数约束

    这篇文章主要介绍了C#泛型的类型参数约束的相关资料，文中讲解非常细致，帮助大家更好的理解和学习c#，感兴趣的朋友可以了解下...2020-07-31

  • C# List介绍及具体用法

    这篇文章主要介绍了C# List介绍及具体用法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2020-06-25

  • Java List集合返回值去掉中括号('[ ]')的操作

    这篇文章主要介绍了Java List集合返回值去掉中括号('[ ]')的操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2020-08-29

  • C#中out参数、ref参数与值参数的用法及区别

    这篇文章主要给大家介绍了关于C#中out参数、ref参数与值参数的用法及区别的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2020-06-25

  • R语言-如何将list转换为向量

    这篇文章主要介绍了R语言-将list转换为向量的操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2021-05-06

  • 处理@PathVariable注解允许参数为空、允许不传参数的问题

    这篇文章主要介绍了处理@PathVariable注解允许参数为空、允许不传参数的问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧...2021-02-23