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;

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

您可能感兴趣的文章:

基于MapReduce实现决策树算法
这篇文章主要为大家详细介绍了基于MapReduce实现决策树算法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-08-08
java获取nvidia显卡信息的实现示例
现在的需求是要获取nvidia显卡的使用情况,本文主要介绍了java获取nvidia显卡信息的实现示例,具有一定的参考价值,感兴趣的可以了解一下
2024-02-02
java实现中英文混合字符截取方法
这篇文章主要为大家详细介绍了java实现中英文混合字符的截取方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-06-06
java中的BlockingQueue(阻塞队列)解析
这篇文章主要介绍了java中的BlockingQueue阻塞队列解析,阻塞队列是一个支持两个附加操作的队列,这两个附加的操作是,在队列为空时,获取元素的线程会等待队列变为非空,需要的朋友可以参考下
2023-12-12
Java HashMap在遍历时删除元素的实现
本文主要介绍了Java HashMap在遍历时删除元素的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2023-12-12
使用Java实现百万Excel数据导出
这篇文章主要为大家详细介绍了如何使用Java实现百万Excel数据导出,文中的示例代码讲解详细,具有一定的借鉴价值,有需要的小伙伴可以参考一下
2024-03-03
Java别说取余（%）运算简单你真的会吗
这篇文章主要介绍了Java别说取余（%）运算简单你真的会吗，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-07-07
Java注解@Transactional事务类内调用不生效问题及解决办法
这篇文章主要介绍了Java注解@Transactional事务类内调用不生效问题及解决办法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-05-05
详解spring cloud feign踩坑记录
这篇文章主要介绍了spring cloud feign踩坑记录，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-06-06
Java并发包线程池ThreadPoolExecutor的实现
本文主要介绍了Java并发包线程池ThreadPoolExecutor的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-04-04