这篇文章主要介绍了Swagger注解-@ApiModel和@ApiModelProperty的用法，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
@ApiModel
使用场景
在实体类上边使用，标记类时swagger的解析类
概述
提供有关swagger模型的其它信息，类将在操作中用作类型时自动内省
属性
| 属性名称 | 数据类型 | 默认值 | 说明 |
|---|---|---|---|
| value | String | 类名 | 为模型提供备用名称 |
| description | String | “” | 提供详细的类描述 |
| parent | Class<?> parent | Void.class | 为模型提供父类以允许描述继承关系 |
| discriminatory | String | “” | 支持模型继承和多态，使用鉴别器的字段的名称，可以断言需要使用哪个子类型 |
| subTypes | Class<?>[] | {} | 从此模型继承的子类型数组 |
| reference | String | “” | 指定对应类型定义的引用，覆盖指定的任何其他元数据 |
@ApiModelProperty
使用场景
使用在被 @ApiModel 注解的模型类的属性上
概述
添加和操作模型属性的数据
属性
| 属性名称 | 数据类型 | 默认值 | 说明 |
|---|---|---|---|
| value | String | “” | 属性简要说明 |
| name | String | “” | 运行覆盖属性的名称。重写属性名称 |
| allowableValues | String | “” | 限制参数可接收的值，三种方法，固定取值，固定范围 |
| access | String | “” | 过滤属性，参阅:io.swagger.core.filter.SwaggerSpecFilter |
| notes | String | “” | 目前尚未使用 |
| dataType | String | “” | 参数的数据类型，可以是类名或原始数据类型，此值将覆盖从类属性读取的数据类型 |
| required | boolean | false | 是否为必传参数,false:非必传参数; true:必传参数 |
| position | int | 0 | 允许在模型中显示排序属性 |
| hidden | boolean | false | 隐藏模型属性，false:不隐藏; true:隐藏 |
| example | String | “” | 属性的示例值 |
| readOnly | boolean | false | 指定模型属性为只读，false:非只读; true:只读 |
| reference | String | “” | 指定对应类型定义的引用，覆盖指定的任何其他元数据 |
| allowEmptyValue | boolean | false | 允许传空值，false:不允许传空值; true:允许传空值 |
Swagger踩坑@ApiModel注解问题
@ApiModel内的注释 不要出现相同 否则会将相同的vo内的字段进行合并
补充：
@ApiModel(description = "码农") description内的值 不要相同就可以避免
例如改为：@ApiModel(description = "码农2")
以上为个人经验，希望能给大家一个参考，也希望大家多多支持编程学习网。
沃梦达教程
本文标题为：Swagger注解-@ApiModel和@ApiModelProperty的用法
基础教程推荐
猜你喜欢
- Java实现线程插队的示例代码 2022-09-03
- JDK数组阻塞队列源码深入分析总结 2023-04-18
- java实现多人聊天系统 2023-05-19
- Java数据结构之对象比较详解 2023-03-07
- java基础知识之FileInputStream流的使用 2023-08-11
- Java实现查找文件和替换文件内容 2023-04-06
- springboot自定义starter方法及注解实例 2023-03-31
- ConditionalOnProperty配置swagger不生效问题及解决 2023-01-02
- Java并发编程进阶之线程控制篇 2023-03-07
- Java文件管理操作的知识点整理 2023-05-19
