基于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) {...}
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。
相关文章
这篇文章主要介绍了Java中如何使用stream流，文章围绕Stream API支持的许多操作展开主题，感兴趣的小伙伴可以参考一下2022-09-09
SpringSecurity整合springBoot、redis实现登录互踢功能
这篇文章主要介绍了SpringSecurity整合springBoot、redis实现登录互踢,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2021-05-05
本文主要介绍了使用Maven快速生成SpringBoot项目打包文件的方法,包括如何生成可执行的JAR文件,如何将配置文件、运行脚本、调试脚本、证书文件等拷贝到指定目录,及如何编译出部署包,这种方法能大大方便微服务的部署,提高部署效率2024-10-10
这篇文章主要介绍了SpringBoot 2 统一异常处理过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2019-09-09
这篇文章主要介绍了Java的List集合框架之LinkedList详细解析,LinkedList底层是内部Node类的存储,prev、next、item值,同时最外层还有first、last节点,需要的朋友可以参考下2023-11-11
SpringBoot中的自定义FailureAnalyzer详解
这篇文章主要介绍了SpringBoot中的自定义FailureAnalyzer详解,FailureAnalyzer是一种很好的方式在启动时拦截异常并将其转换为易读的消息,并将其包含在FailureAnalysis中, Spring Boot为应用程序上下文相关异常、JSR-303验证等提供了此类分析器,需要的朋友可以参考下2023-12-12
这篇文章主要介绍了java文件操作中的java写文件示例,需要的朋友可以参考下2014-03-03
本文给大家介绍Go并发编程中使用channel的方法，通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友参考下吧2021-11-11
这篇文章主要介绍了SpringData JPA 如何搭建 xml的配置方式,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧2023-12-12
这篇文章主要介绍了java实现Api接口加密通信方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2023-06-06
最新评论