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",
      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;

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

赞 (0)

相关推荐

  • SpringBoot中的@ApiModelProperty注解作用

    目录 @ApiModelProperty注解作用 主要字段说明 举个简单的例子 @ApiModelProperty()失效 解决方法 @ApiModelProperty注解作用 @ApiModelProperty()注解用于方法.字段,表示对model属性的说明或者数据操作更改,以下是它的源码: // IntelliJ API Decompiler stub source generated from a class file // Implementation of methods is no

  • 解决springboot引入swagger2不生效问题

    目录 问题描述: springboot引入swagger2的步骤: ①引入依赖 ②编写Swagger2的配置类 ③在controller中添加注解:按需添加注解 ④在model(pojo)上加注解,按需添加 一些注解的使用 今天遇到跟同事遇到一个由于失误导致的问题,也可以说比较难发现了.在此记录一下(我们用的springboot是2.0.3,swagger是2.2.2) 问题描述: swagger修改title,description等都不生效.并且启动springboot,没有有去加载swag

  • swagger @ApiModel添加实体类不生效的解决

    swagger @ApiModel添加实体类不生效的解决

    目录 @ApiModel添加实体类不生效 Models实体类无法显示 解决办法 @ApiModel添加实体类不生效 swagger, @ApiModel, Models, 实体类无法加载 在使用swagger时, 以为加上@ApiModel在实体类上就可以在swagger-ui.html的Models里面显示. 但是我创建了很多实体类, 但怎么也只显示了一个??? Models中无论如何只有User这一个实体类. 后来发现不是加上@ApiModel就可以加入Models中的,必须要在contro

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

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

    目录 swagger注解@ApiModelProperty失效 swagger 版本 2.29.2 解决方式: 小写字段名 @ApiModelProperty注解的使用 下面是它内部的常用属性 swagger注解@ApiModelProperty失效 swagger 版本 2.29.2 解决方式: 小写字段名 @ApiModelProperty注解的使用 首先要知道@ApiModelProperty是swagger的注解,它的作用是添加和操作属性模块的数据 下面是它内部的常用属性 1.value

  • 解决没有@RunWith 和 @SpringBootTest注解或失效问题

    导入别人的项目 或者 自己想创建一个测试类 经常会遇见了这个问题没有@RunWith 和 @SpringBootTest注解或失效 网上搜了搜 全是我下面的第一个解决方案 第二个才是重点 解决方案 1 添加依赖 如果 你是springboot项目 pom文件中添加 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</

  • Mybatis 缓存原理及失效情况解析

    Mybatis 缓存原理及失效情况解析

    这篇文章主要介绍了Mybatis 缓存原理及失效情况解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 1.什么是缓存[Cache] 存在内存中的临时数据. 将用户经常查询的数据放在缓存(内存)中,用户去查询数据就不用从磁盘上(关系型数据库数据文件)查询,从缓存中查询,从而提高查询效率,解决了高并发系统的性能问题. 2.为什么要使用缓存 减少和数据库的交互次数,减少系统开销,提高系统效率. 3.什么样的数据需要使用缓存 经常查询且不易改变的数据

  • Spring事务注解@Transactional失效的八种场景分析

    首先说一下最近自己遇到的一个坑: @Transactional service A(){ try{ insert(); serviceB.update(); }catch(){ throw new RunTimeException(); } } serviceB(){ @Transactional update(){ try{ mapperB.update(); }catch(){ throw new RunTimeException(); } } } mapperB (){ try{ //do

  • mysql排序失效问题的解决

    mysql排序失效问题的解决

    目录 问题 解决: 问题 可以看到sql语句是没有问题的,但是排序缺出现问题 发现这个字段是varchar类型.不能直接排序 解决: 在不修改原有设计的情况下,只能改SQL了,我们需要先把字符串转数字. 字符串转数字的三种方式: (1)+0 order by (serial_number+0) desc (2)用函数CAST(value as type)或CONVERT(value, type) type可为DECIMAL (浮点数 ).SIGNED(整数).UNSIGNED (无符号整数 )

  • vue 数组和对象不能直接赋值情况和解决方法(推荐)

    Vue 不能检测以下变动的数组: 当你利用索引直接设置一个项时,例如:vm.items[indexOfItem] = newValue 当你修改数组的长度时,例如:vm.items.length = newLength 当第一种情况需求时,可以使用this.$set(this.arr,index,newVal) Vue 不能检测对象属性的添加或删除: 可以使用this.$set(this.person,'age',12) 当需要添加多个对象时,Object.assign({},this.pers

  • BootStrap Validator 版本差异问题导致的submitHandler失效问题的解决方法

    我用过的两个版本: v0.5.2-dev,0.4.5 这里针对于提交方法进行说明一下,如下代码: <script> $(function () { $("#addUserForm").bootstrapValidator({ submitHandler: function(validator, form, submitButton) { // 版本号0.4.5支持 // 版本号v0.5.2-dev不再支持submitHandler配置 } }).on("succe

  • php倒计时出现-0情况的解决方法

    本文实例讲述了php倒计时出现-0情况的解决方法.分享给大家供大家参考,具体如下: 问题:今天有反馈,说倒计时出现了-0天的情况,我看了看程序,卧槽,当时怎么没测试到 原因是PHP的逻辑判断中 -0 > 0 分析:贴出错的代码 $starttime = 1362585600; //3.7凌晨 $nowtime = 1362618921;//3.7早上 $off = ceil(($starttime - $nowtime)/86400); //倒计时 if ($off < 0) { $off =

  • 详谈表单重复提交的三种情况及解决方法

    详谈表单重复提交的三种情况及解决方法

    第一种情况:提交完表单以后,不做其他操作,直接刷新页面,表单会提交多次. - 在servlet中写一句输出,用来判断是否提交多次 System.out.println("已经插入"); request.getRequestDispatcher("/login_success.jsp").forward(request, response); - 这样的话,刷新多少次,就会在控制器显示多少个"已经插入". - 根本原因:Servlet处理完请求以后

  • ajax在兼容模式下失效的快速解决方法

    使用jQuery,用ajax实现局部刷新功能,在火狐,360急速浏览器高速模式下,ie8,9都能正常运行,但切换到兼容模式下无效,解决办法有两种关闭浏览器兼容性视图,二是引入json2.js文件 这里采用第一种,并且使用一种完美兼容性解决办法,在head头部加入 <meta http-equiv="X-UA-Compatible" content="IE=9;IE=8;IE=7;IE=EDGE"> 即可! 以上这篇ajax在兼容模式下失效的快速解决方法就

随机推荐