Java中注解@RequestParam 和 @ApiParam详解
在Java中,@RequestParam
和 @ApiParam
都是用来标注方法参数的注解,但它们的用途和处理方式有所不同。
@RequestParam
是Spring框架中的注解,用于将请求参数绑定到控制器的方法参数上。
示例代码:
@GetMapping("/getUser")
public User getUser(@RequestParam("id") Long id) {
// 根据id获取用户信息
}
在这个例子中,@RequestParam("id")
表示请求中名为 "id" 的参数将被绑定到方法参数 id
上。
@ApiParam
是Swagger框架中的注解,用于为API方法的参数提供元数据(如描述、名称等)。它不直接绑定请求参数,但可以配合Swagger UI使用。
示例代码:
@GetMapping("/getUser")
public User getUser(@RequestParam(value = "id", required = true) Long userId) {
// 根据id获取用户信息
}
@ApiOperation(value = "获取用户信息", notes = "根据用户ID获取用户详细信息")
@ApiImplicitParams({
@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long", paramType = "query")
})
public User getUser(@RequestParam("id") Long id) {
// 根据id获取用户信息
}
在这个例子中,@ApiParam(name = "id", value = "用户ID", required = true)
表示在API文档中,该参数是必须的,名称为"用户ID"。
总结:@RequestParam
用于请求参数绑定,而 @ApiParam
用于Swagger文档生成。
评论已关闭