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

更新时间：2022年06月14日 08:57:23 作者：9233

这篇文章主要介绍了swagger注解@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",
      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;

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

Java Volatile关键字你真的了解吗
这篇文章主要为大家介绍了Java Volatile关键字，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助
2021-12-12
关于spring中单例Bean引用原型Bean产生的问题及解决
这篇文章主要介绍了关于spring中单例Bean引用原型Bean产生的问题及解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-06-06
springboot如何获取接口下所有实现类
这篇文章主要介绍了springboot如何获取接口下所有实现类问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-09-09
jdbc连接数据库实例详解
在本篇内容里小编给大家分享了关于jdbc如何连接数据库的相关知识点内容，需要的朋友们学习下。
2019-02-02
SpringBoot项目启动后立马自动关闭的解决方案
这篇文章主要介绍了SpringBoot项目启动后立马自动关闭的解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-03-03
java中接口和事件监听器的深入理解
这篇文章主要给大家介绍了关于java中接口和事件监听器的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用java具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
2019-12-12
解读Spring Bean的作用域
这篇文章主要介绍了解读Spring Bean的作用域，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-10-10
Intellij IDEA如何查看所有断点
这篇文章主要介绍了Intellij IDEA如何查看所有断点问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-03-03
SpringMVC的简单传值(实现代码)
下面小编就为大家带来一篇SpringMVC的简单传值(实现代码)。小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2016-05-05
mybatis自动扫描和自定义类注解方式
这篇文章主要介绍了mybatis自动扫描和自定义类注解方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-10-10