SpringBoot使用Swagger2版本和@RequestParam注解在Controller中编写的每个接口的参数添加中文备注
时间: 2024-02-27 21:52:17 浏览: 130
在SpringBoot中使用Swagger2版本和@RequestParam注解可以很方便地为Controller中编写的每个接口的参数添加中文备注,具体步骤如下:
1. 在Controller方法的参数前使用@RequestParam注解,通过value属性设置参数的描述信息。
```java
@RestController
@Api(tags = "用户管理接口")
public class UserController {
@ApiOperation(value = "获取用户列表", notes = "获取所有用户的列表信息")
@RequestMapping(value = "/users", method = RequestMethod.GET)
public List<User> getUsers(@ApiParam(value = "页码", required = false) @RequestParam(value = "pageNum", required = false, defaultValue = "1") int pageNum,
@ApiParam(value = "每页大小", required = false) @RequestParam(value = "pageSize", required = false, defaultValue = "10") int pageSize) {
// 代码逻辑
}
}
```
2. 在参数上方添加@ApiParam注解,通过value属性设置参数的中文描述信息。
注意事项:使用Swagger2编写API接口参数中文备注时,需要注意参数名称、是否必填、数据类型等信息的准确性,以便生成准确的API文档。
阅读全文