【SpringBoot系列】接口参数的默认值与必要性
在SpringBoot中,我们可以通过@RequestParam注解为接口参数设置默认值,并通过@ApiParam注解为Swagger文档添加参数描述。
解决方案1:
@GetMapping("/getUser")
public User getUser(@RequestParam(value = "id", defaultValue = "0") Long userId) {
return userService.getUserById(userId);
}
在上述代码中,我们通过@RequestParam注解的defaultValue属性为接口参数设置了默认值"0"。
解决方案2:
@GetMapping("/getUser")
public User getUser(@ApiParam(value = "用户ID", required = true) @RequestParam Long userId) {
return userService.getUserById(userId);
}
在上述代码中,我们通过@ApiParam注解的value属性为Swagger文档添加了参数描述,并通过设置required属性为true表示该参数为必传参数。
注意:在SpringBoot中,接口参数的默认值和Swagger文档的参数描述需要分别使用@RequestParam的defaultValue属性和@ApiParam的value属性来设置,不能混淆使用。
评论已关闭