这篇文章主要介绍了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;
以上为个人经验,希望能给大家一个参考,也希望大家多多支持编程学习网。
本文标题为:swagger注解@ApiModelProperty失效情况的解决
基础教程推荐
- Java数据结构之对象比较详解 2023-03-07
- ConditionalOnProperty配置swagger不生效问题及解决 2023-01-02
- JDK数组阻塞队列源码深入分析总结 2023-04-18
- java实现多人聊天系统 2023-05-19
- Java并发编程进阶之线程控制篇 2023-03-07
- Java文件管理操作的知识点整理 2023-05-19
- springboot自定义starter方法及注解实例 2023-03-31
- java基础知识之FileInputStream流的使用 2023-08-11
- Java实现线程插队的示例代码 2022-09-03
- Java实现查找文件和替换文件内容 2023-04-06