zoukankan      html  css  js  c++  java
  • swagger界面非必传参数的设置

    修改之前:

    第一次代码实现:
    @RequestMapping(path="/getByStoreAndTypeAndSn/{storeId}/{versionType}/{terminalSn}", method=RequestMethod.GET )
    public TerminalSet getListByStoreIdAndVersionAndSn(@PathVariable("storeId") Long storeId,@PathVariable("versionType") Integer versionType,@PathVariable("terminalSn") String terminalSn){
        return terminalSetService.getListByStoreIdAndVersionAndSn(storeId,versionType,terminalSn);
    }

    第二次代码实现:
    @ApiOperation(value="根据分店编号和版本类型,设备Sn号获取注册信息,用于设备加载时认证")
    @RequestMapping(path="/getByStoreAndTypeAndSn", method=RequestMethod.GET )
    @ApiImplicitParams({
    @ApiImplicitParam(name="storeId",value="部门编号",paramType = "query"),
    @ApiImplicitParam(name="versionType",value="版本类型(0-总店版 1-门店版 2-收银台版)",allowableValues="0,1,2",paramType = "query",required=true),
    @ApiImplicitParam(name="terminalSn",value="设备Sn号",paramType = "query",required=true),
    })
    public TerminalSet getListByStoreIdAndVersionAndSn(@RequestParam Long storeId, @RequestParam Integer versionType,@RequestParam String terminalSn){
    return terminalSetService.getListByStoreIdAndVersionAndSn(storeId,versionType,terminalSn);
    }



    修改之后:
    @ApiOperation(value="根据分店编号和版本类型,设备Sn号获取注册信息,用于设备加载时认证")
    @RequestMapping(path="/getByStoreAndTypeAndSn", method=RequestMethod.GET )
    @ApiImplicitParams({
    @ApiImplicitParam(name="storeId",value="部门编号",paramType = "query",required=false),
            @ApiImplicitParam(name="versionType",value="版本类型(0-总店版 1-门店版 2-收银台版)",allowableValues="0,1,2",paramType = "query",required=true),
    @ApiImplicitParam(name="terminalSn",value="设备Sn号",paramType = "query",required=true),
    })
    public TerminalSet getListByStoreIdAndVersionAndSn( Long storeId, Integer versionType, String terminalSn){
    return terminalSetService.getListByStoreIdAndVersionAndSn(storeId,versionType,terminalSn);
    }

    总结:
    设置非必传参数时,不能用
    /getByStoreAndTypeAndSn/{storeId}/{versionType}/{terminalSn} 这种方式传参
    当使用 @ApiImplicitParams注解时已经设置了参数的的基础信息,就无须再使用 @RequestParam注解
    如果未使用@ApiImplicitParams注解时,用 @RequestParam注解来设置需要传入的参数,此时需要用 required 来设置是否为必传参数,true为必传,false为非必传。


  • 相关阅读:
    33.数组声明方式(var构造函数) 、检测数组类型、数组的属性(封装好的就一个length)、数组的方法
    31.this指向(写出调用链,找最近对象) this的默认绑定 隐式绑定 显示绑定(call(绑定对象) apply(绑定对象) 当括号内没放绑定对象的时候恢复默认绑定) bind
    31.
    30.函数作用域链 (GO AO 也叫词法作用域链)、 调用栈、调用栈涉及this绑定
    29.包装类(构造函数) 包装类作用及调用栈
    916. Word Subsets
    246. Strobogrammatic Number
    445. Add Two Numbers II
    2. Add Two Numbers
    341. Flatten Nested List Iterator
  • 原文地址:https://www.cnblogs.com/gemiaomiao/p/10700032.html
Copyright © 2011-2022 走看看