Swagger入参为List

Posted coisini

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Swagger入参为List相关的知识,希望对你有一定的参考价值。

今天遇到一个奇葩的需求,为了方便,service的一个接口入参是List<Map>
repayMoney(List<Map<String,Object>)
那,我为了在controller调用service,入参类型得一致呀,
那么问题来了,controller入参也得是List吧,或者是其他形式的数据,转换为List<Map>
翻遍了整个项目,没看到之前有人swagger的controller里入参是List的,而且查了一下,
用@ApiImplicitParams注解的话,入参只能是String或者Integer,啊,这可怎么办,类似于这样
关注点在入参为List,这个测试写的不完善,大家只要关注入参就可以了

 

@ApiOperation(value = "测试")
    @RequestMapping(value = "/sanbiaoRepaymentAmount",method = RequestMethod.POST)
    @ApiImplicitParams({@ApiImplicitParam(name = "idCard", dataType = "String", value = "身份证号", paramType = "query", required = true),
            @ApiImplicitParam(name = "userNo", dataType = "Integer", value = "编号", paramType = "query", required = true),
            @ApiImplicitParam(name = "onePeriodAmount", dataType = "String", value = "金额", paramType = "query", required = true)})
    @ResponseBody
    public Result sanbiaoRepaymentAmount(@RequestParam(value = "idCard", required = true) String idCard,
                                         @RequestParam(value = "userNo", required = true) Integer userNo,
                                         @RequestParam(value = "onePeriodAmount", required = true) String onePeriodAmount) {
        Result result = new ResultSupport();
        List<Map<String,Object>> repayList = new ArrayList<Map<String,Object>>();
        Map paramMap = new HashMap();
        paramMap.put("idCard",idCard);
        paramMap.put("userNo",userNo);
        paramMap.put("onePeriodAmount",onePeriodAmount);
        repayList.add(paramMap);
        userService.repayMoney(repayList);
        return result;
    }

  

 

好吧,查了一下,好像去掉ApiImplicitParams,就可以传list,
于是 我做了如下修改
 
@ApiOperation(value = "测试")
    @RequestMapping(value = "/sanbiaoRepaymentAmount",method = RequestMethod.POST)
    @ResponseBody
    public Result sanbiaoRepaymentAmount(@RequestParam(value = "idCardList", required = true) List<String> idCardList,
                                         @RequestParam(value = "userNoList", required = true) List<Integer> userNoList,
                                         @RequestParam(value = "onePeriodAmountList", required = true) List<String> onePeriodAmountList) {

        Result result = new ResultSupport();
        List<Map<String,Object>> repayList = new ArrayList<Map<String,Object>>();
        Map paramMap = new HashMap();
        for(int i=0; i<idCardList.size(); i++){
            //因为这里十分确定,三个入参list的长度是一致的,所以,在这里,把三个List对应的下标参数放在map里
            paramMap.put("idCard",userNoList.get(i));
            paramMap.put("userNo",onePeriodAmountList.get(i));
            paramMap.put("onePeriodAmount",onePeriodAmountList.get(i));
            repayList.add(paramMap);
        }
        System.out.println("haha");
        System.out.println(repayList);
     System.out.println(repayList.getClass());
        userService.repayMoney(repayList);
        return result;
    }

  

 

开始测试--Swagger入参是这样得,看吧,DataType 是Array,数组呗

技术分享图片

逗号分隔参数,就可以咯

技术分享图片

顺利经过测试,能走到repayMoney()

技术分享图片

 

 

 

以上是关于Swagger入参为List的主要内容,如果未能解决你的问题,请参考以下文章

课时5 入参为HashMap,以及mybatis调用存储过程CRUD

接雨水-入参为ArrayList<Integer>类型

Python+requests库发送接口入参为xml格式的接口请求多测师

Python+requests库发送接口入参为xml格式的接口请求多测师

RobotFramework:发现一个大坑,当post接口入参为json时,千万不能用sojson转化后的json串,直接用浏览器粘过来的就行

list