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;

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

相关文章

  • Spring DI依赖注入过程解析

    Spring DI依赖注入过程解析

    依赖注入是由“依赖”和“注入”两个词汇组合而成,那么我们再一次顺藤摸瓜,分别分析这两个词语,这篇文章主要介绍了Spring DI依赖注入详解,需要的朋友可以参考下
    2022-11-11
  • Java8 用Lambda表达式给List集合排序的实现

    Java8 用Lambda表达式给List集合排序的实现

    这篇文章主要介绍了Java8 用Lambda表达式给List集合排序的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-08-08
  • 如何避免在Java 中使用双括号初始化

    如何避免在Java 中使用双括号初始化

    这篇文章主要介绍了如何避免在Java中使用双括号初始化,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-07-07
  • IDEA生成patch和使用patch的方法实现

    IDEA生成patch和使用patch的方法实现

    比如你本地修复的 bug,需要把增量文件发给客户,很多场景下大家都需要手工整理修改的文件,并整理好目录,这个很麻烦,那有没有简单的技巧呢?本文主要介绍了IDEA生成patch和使用patch的方法实现,感兴趣的可以了解一下
    2023-08-08
  • 解决get请求入参@NotNull验证不生效问题

    解决get请求入参@NotNull验证不生效问题

    这篇文章主要介绍了解决get请求入参@NotNull验证不生效问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • 面试题:Java 实现查找旋转数组的最小数字

    面试题:Java 实现查找旋转数组的最小数字

    这篇文章主要介绍了Java 实现查找旋转数组的最小数字,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-07-07
  • Spring Boot使用FastJson解析JSON数据的方法

    Spring Boot使用FastJson解析JSON数据的方法

    本篇文章主要介绍了Spring Boot使用FastJson解析JSON数据的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-02-02
  • 常用数据库的驱动程序及JDBC URL分享

    常用数据库的驱动程序及JDBC URL分享

    这篇文章主要介绍了常用数据库的驱动程序及 JDBC URL,需要的朋友可以看下
    2014-01-01
  • springboot如何去除debug日志

    springboot如何去除debug日志

    这篇文章主要介绍了springboot如何去除debug日志的方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06
  • Spring Boot如何防止重复提交

    Spring Boot如何防止重复提交

    这篇文章主要为大家详细介绍了Spring Boot如何防止重复提交,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-08-08

最新评论