行业资讯 2025年08月6日
0 收藏 0 点赞 791 浏览 1536 个字
摘要 :

文章目录 1.、value() 2、name() 3、allowableValues() 4、access() 5、notes() 6、dataType() 7、required() 8、 position() 9、hidden() 10、example() 11、readOnly(……




  • 1.、value()
  • 2、name()
  • 3、allowableValues()
  • 4、access()
  • 5、notes()
  • 6、dataType()
  • 7、required()
  • 8、 position()
  • 9、hidden()
  • 10、example()
  • 11、readOnly()
  • 12、reference()
  • 13、allowEmptyValue()
  • 示例

学过Swagger的应该都知道@ApiModelProperty是Swagger的常用注解,它的作用是添加和操作属性模块的数据,以下总结了@ApiModelProperty内部的常用属性:

1.、value()

参数类型为String,作用为此属性的简要描述。源码:

String value() default \"\";

2、name()

参数类型为String,作用为允许重写属性的名称。源码:

String name() default \"\";

3、allowableValues()

参数类型为String,作用为允许此参数存储的长度。源码:

String allowableValues() default \"\";

4、access()

参数类型为String,作用为允许从API文档中过滤属性。源码:

String access() default \"\";

5、notes()

参数类型为String,作用为该字段的注释说明。源码:

String notes() default \"\";

6、dataType()

参数类型为String,作用为参数的数据类型。源码:

String dataType() default \"\";

7、required()

参数类型为boolean,作用为指定参数是否可以为空,默认为false。源码:

boolean required() default false;

8、 position()

参数类型为int,作用为允许显式地对模型中的属性排序。源码:

int position() default 0;

9、hidden()

参数类型为boolean,作用为是否允许模型属性隐藏在Swagger模型定义中,默认为false。源码:

boolean hidden() default false;

10、example()

参数为String类型,作用为属性的示例值。源码:

String example() default \"\";

11、readOnly()

参数类型为boolean,作用为是否允许将属性指定为只读,默认为false。源码:

boolean readOnly() default false;

12、reference()

参数类型为String,作用为指定对对应类型定义的引用,重写指定的任何其他数据名称。源码:

String reference() default \"\";

13、allowEmptyValue()

参数类型为boolean,作用为是否允许传递空值,默认为false源码:

boolean allowEmptyValue() default false;

示例

  @ApiModelProperty(value = \"ID主键\",name = \"id\",
        allowableValues = \"20\",
      access = \"1\",
      notes = \"学生的id\",
      dataType = \"int\",
      required = false,
      position = 1,
      hidden = true,
      example = \"1\",
      readOnly = false,
      reference = \"id\",
      allowEmptyValue = false)
  @TableId(value = \"id\",type = IdType.AUTO)
  private Integer id;

以上就是Swagger @ApiModelProperty详解内容。

微信扫一扫

支付宝扫一扫

版权: 转载请注明出处:https://www.zuozi.net/9435.html

管理员

相关推荐
2025-08-06

文章目录 一、Reader 接口概述 1.1 什么是 Reader 接口? 1.2 Reader 与 InputStream 的区别 1.3 …

988
2025-08-06

文章目录 一、事件溯源 (一)核心概念 (二)Kafka与Golang的优势 (三)完整代码实现 二、命令…

465
2025-08-06

文章目录 一、证明GC期间执行native函数的线程仍在运行 二、native线程操作Java对象的影响及处理方…

348
2025-08-06

文章目录 一、事务基础概念 二、MyBatis事务管理机制 (一)JDBC原生事务管理(JdbcTransaction)…

456
2025-08-06

文章目录 一、SnowFlake算法核心原理 二、SnowFlake算法工作流程详解 三、SnowFlake算法的Java代码…

517
2025-08-06

文章目录 一、本地Jar包的加载操作 二、本地Class的加载方法 三、远程Jar包的加载方式 你知道Groo…

832
发表评论
暂无评论

还没有评论呢,快来抢沙发~

助力内容变现

将您的收入提升到一个新的水平

点击联系客服

在线时间:08:00-23:00

客服QQ

122325244

客服电话

400-888-8888

客服邮箱

122325244@qq.com

扫描二维码

关注微信客服号