@ApiModelProperty注解的用法(官方平台推荐文章)

首先要知道@ApiModelProperty是swagger的注解，它的作用是添加和操作属性模块的数据，下面是它内部的常用属性：

1、value()

源码：String value() default "";

参数类型为String，作用为此属性的简要描述。

2、name()

源码： String name() default "";

参数类型为String，作用为允许重写属性的名称。

3、allowableValues()

源码：String allowableValues() default "";

参数类型为String，作用为允许此参数存储的长度。

4、access()

源码：String access() default "";

参数类型为String，作用为允许从API文档中过滤属性

5、notes()

源码： String notes() default "";

参数类型为String，作用为该字段的注释说明

6、dataType()

源码： String dataType() default "";

参数类型为String，作用为参数的数据类型。

7、required()

源码：boolean required() default false;

参数类型为boolean，作用为指定参数是否可以为空，默认为false

8、 position()

源码：int position() default 0;

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

9、hidden()

源码：boolean hidden() default false;

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

10、example()

源码：String example() default "";

参数为String类型，作用为属性的示例值。

11、readOnly()

源码：boolean readOnly() default false;

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

12、reference()

源码： String reference() default "";

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

13、allowEmptyValue()

源码：boolean allowEmptyValue() default false;

参数类型为boolean，作用为是否允许传递空值，默认为false

示例：

  @ApiModelProperty(value = "主键",name = "id",
  	  allowableValues = "32",
      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 int id;