关于@ApiModel和@ApiModelProperty的使用
更新时间：2023年11月20日 16:29:54 作者：Zz_糖小七
这篇文章主要介绍了关于@ApiModel和@ApiModelProperty的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
版本
- springfox-swagger2 (version = 2.9.2)
- swagger-bootstrap-ui (version = 1.9.6)
- swagger-models (version =1.6.1)
@ApiModel
使用场景
在实体类上边使用，标记类时swagger的解析类
| 属性名称 | 数据类型 | 默认值 | 说明 |
|---|---|---|---|
| value | String | 类名 | 为模型提供备用名称 |
| description | String | " | 提供详细的类描述 |
| parent | Class<?> | Void.class | 为模型提供父类以允许描述继承关系 |
| discriminator | String | " | 支持模型继承和多态，使用鉴别器的字段的名称，可以断言需要使用哪个子类型 |
| subTypes | Class<?>[] | {} | 从此模型继承的子类型数组 |
| reference | String | ‘’ | 指定对应类型定义和引用，覆盖指定的任何其它元数据 |
@ApiModelProperty
使用场景
使用在被 @ApiModel 注解的模型类的属性上
| 属性名称 | 数据类型 | 默认值 | 说明 |
|---|---|---|---|
| value | String | " | 属性简要说明 |
| name | String | " | 运行覆盖属性的名称，重写属性名称 |
| allowableValues | String | " | 限制参数可接受的值 |
| access | String | " | 过滤属性 |
| notes | String | " | 尚未使用 |
| dataType | String | " | 参数的数据类型 |
| required | boolean | false | 是否必传 |
| position | int | 0 | 允许在模型中排序属性 |
| hidden | boolean | false | 隐藏模型属性 |
| example | String | " | 属性的示例值 |
| readOnly | boolean | false | 指定模型属性为只读，false:非只读 |
| reference | String | " | 指定对应类型定义的引用，覆盖指定的任何其他元数据 |
| allowEmptyValue | boolean | false | 允许传空置，false：不允许传空值 |
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
这篇文章主要介绍了MyBatis根据条件批量修改字段的方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2023-02-02
Java 8 Stream Api 中的 map和 flatMap 操作方法
Java 8提供了非常好用的 Stream API ,可以很方便的操作集合。今天通过这篇文章给大家分享Java 8 Stream Api 中的 map和 flatMap 操作方法,需要的朋友可以参考下2019-11-11
这篇文章主要介绍了mybatis test标签判断值是否相等的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-07-07
SpringBoot中@Configuration和@Bean和@Component相同点详解
这篇文章主要介绍了SpringBoot中@Configuration和@Bean和@Component相同点详解,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2025-04-04
这篇文章主要介绍了如何使用Code128字体将文本转换为code128条形码 ,非常不错，具有一定的参考借鉴价值，需要的朋友可以参考下2019-04-04
本篇文章主要介绍用JAVA 实现二叉树,并提供实例.对二叉树数据结构很好的学习实践,有需要的朋友可以参考下2016-07-07
今天给大家总结一下SpringBoot下拦截器的使用，需要的朋友参考下吧2017-05-05
出于安全考虑,我们需要后端返回的图片只允许在某个网站内展示,不想被爬虫拿到图片地址后被下载,或者,不想浏览器直接访问图片链接,所以本文将给大家介绍SpringBoot实现图片防盗链功能,需要的朋友可以参考下2024-04-04
关于@JSONField和@JsonFormat的使用区别说明
这篇文章主要介绍了关于@JSONField 和 @JsonFormat的区别说明，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-11-11
这篇文章主要介绍了Java响应式编程之handle用法解析，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-10-10
最新评论