@ApiImplicitParam注解


@ApiImplicitParam是一个标注方法参数的注解

注解内的属性有

name:参数名

value:参数的中文含义

required:是否必须

dataType:参数类型

paramType:参数所放位置

defaultValue:参数的默认值

其中,paramType可选值有header、query、path

header标注为从@RequestHeader中获取

query标注为从@RequestParam中获取

path从标注为@PathVariable中获取

 

方法中有多个参数时,使用@ApiImplicitParams包围

@RequestMapping("/getUser")
@ApiImplicitParams({
            @ApiImplicitParam(name = "userId", value = "用户ID", required = true, dataType = "String", paramType = "Query"),
       @ApiImplicitParam(name = "roleId", value = "角色ID", required = true, dataType = "String", paramType = "Query"),
}) 
public String findUser(String userId,String roleId){ return "success"; }

 


免责声明!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系本站邮箱yoyou2525@163.com删除。



 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM