Java中注解@RequestParam 和 @ApiParam详解
一、@RequestParam 和 @ApiParam的常用属性
@RequestParam 和 @ApiParam 是在 Spring MVC 控制器方法中使用的注解，它们分别服务于不同的目的：
@RequestParam
RequestParam 是 Spring MVC 中用来处理 HTTP 请求参数的注解，主要用于绑定请求中的查询参数或表单字段到控制器方法的参数。
| 属性名 | 详解 |
|---|---|
| value / name | 指定请求参数的名称。如果未指定，则默认使用参数变量名作为请求参数名 |
| required | 布尔值，默认为 false。当设置为 true 时，表示该请求参数是必需的，若客户端没有提供则会抛出异常 |
| defaultValue | 提供一个默认值，如果请求中没有包含该参数，则使用这个默认值 |
| paramType | 参数类型（如 query、form 等），但通常可以省略，Spring Boot 能够根据上下文自动推断 |
@ApiParam
ApiParam 是 Swagger 或 OpenAPI 规范的一部分，在 Springfox 或其他实现中使用，用于增强 API 文档生成，提供更丰富的参数描述信息。
| 属性名 | 详解 |
|---|---|
| value | 对应于请求参数的说明性文字，会在生成的文档中展示。 |
| name | 对应于请求参数的实际名称，与 @RequestParam 的 name 属性类似 |
| example | 提供一个示例值，帮助理解参数可能的取值 |
| required | 表明该参数是否在调用接口时必须提供 |
| allowableValues | 可以定义允许的值范围或枚举值 |
| defaultValue | 在文档中显示的默认值 |
| dataType | 数据类型，例如 String, Integer 等，用于详细说明参数的数据类型 |
| allowMultiple | 如果参数可以接受多个值，设为 true |
结合使用时，@RequestParam 用于实际处理和验证请求参数，而 @ApiParam 则为这些参数提供了更加详细的元数据信息，以便在自动生成的 API 文档中展示给开发者
二、实际使用场景示例
/**
* 审核提交
* @param type
* @param applyState
* @param req
* @return
*/
@AutoLog(value = "数据审核-审核提交")
@ApiOperation(value = "数据审核-审核提交",notes = "数据审核-审核提交")
@PostMapping(value = "/toExamines")
public Result toExamines(
@ApiParam(value = "查询类型：1-教师，2-学生",name = "type",required = true, example = "1")
@RequestParam Integer type,
@ApiParam(value = "审核状态：3_审核通过，4_审核驳回",name = "applyState",required = true, example = "")
@RequestParam Integer applyState,
HttpServletRequest req) {
// 实际业务逻辑代码
return null;
}
文档示例：
调试示例：
免责声明：我们致力于保护作者版权，注重分享，被刊用文章因无法核实真实出处，未能及时与作者取得联系，或有版权异议的，请联系管理员，我们会立即处理! 部分文章是来自自研大数据AI进行生成,内容摘自(百度百科,百度知道,头条百科,中国民法典,刑法,牛津词典,新华词典,汉语词典,国家院校,科普平台)等数据,内容仅供学习参考,不准确地方联系删除处理! 图片声明：本站部分配图来自人工智能系统AI生成,觅知网授权图片,PxHere摄影无版权图库和百度，360，搜狗等多加搜索引擎自动关键词搜索配图，如有侵权的图片，请第一时间联系我们，邮箱：ciyunidc@ciyunshuju.com。本站只作为美观性配图使用,无任何非法侵犯第三方意图,一切解释权归图片著作权方,本站不承担任何责任。如有恶意碰瓷者,必当奉陪到底严惩不贷!
