swagger注解@ApiModelProperty失效情况的解决

目录swagger注解@ApiModelProperty失效swagger 版本 2.29.2解决方式: 小写字段名@ApiModelProperty注解的使用下面是它内部的常用属性

swagger注解@ApiModelProperty失效

swagger 版本 2.29.2

解决方式: 小写字段名

@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;

参数类型为String，作用为指定参数是否可以为空，默认为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",

dataTNtvxbilisype = "int",

required = false,

position = 1,

hidden = true,

example = "1",

readOnly = false,

reference = "id",

allowEmptyValue = false)

@TableId(value = "id",type = IdType.AUTO)

private int id;

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。