关于@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：不允许传空值 |
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
构建模式主要用来针对复杂产品生产，分离部件构建细节，以达到良好的伸缩性,考虑到设计模式来源于建筑学,因此举一个建造房子的例子,需要的朋友可以参考下2012-12-12
这篇文章主要介绍了浅谈Java高并发解决方案以及高负载优化方法，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-08-08
这篇文章主要介绍了使用Java将一个List运用递归转成树形结构案例,本文通过详细的案例来解释说明了如何去操作,需要的朋友可以参考下2021-06-06
下面小编就为大家带来一篇基于Listener监听器生命周期(详解)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-10-10
这篇文章主要介绍了Springboot接口项目如何使用AOP记录日志,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-06-06
Java将日期类型Date时间戳转换为MongoDB的时间类型数据
今天小编就为大家分享一篇关于Java将日期类型Date时间戳转换为MongoDB的时间类型数据，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧2018-10-10
Spring IOC容器Bean管理的完全注解开发放弃配置文件
这篇文章主要为大家介绍了Spring IOC容器的Bean管理完全注解开发放弃配置文件，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-05-05
这篇文章主要介绍了Java8 Stream flatmap中间操作用法解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-07-07
本文介绍了Spring框架中的立即加载和延迟加载策略，并解释了它们的适用场景和使用方法，根据具体的需求和应用场景，选择合适的加载策略，可以提高应用程序的性能和资源利用效率，感兴趣的朋友跟随小编一起看看吧2023-07-07
读万卷书不如行万里路，只学书上的理论是远远不够的，只有在实战中才能获得能力的提升，本篇文章手把手带你用java+SSM+jsp+mysql+maven实现一个在线点餐系统,大家可以在过程中查缺补漏，提升水平2021-11-11
最新评论