关于@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：不允许传空值 |
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
这篇文章主要介绍了SpringBoot2.0整合WebSocket代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2019-11-11
下面小编就为大家带来一篇浅谈Java中几个常用集合添加元素的效率。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-04-04
在开发中，动态数据源配置还是用的比较多的，比如在多数据源使用方面，又或者是在多个DB之间切换方面。这里给出一个动态数据源的配置方案，感兴趣的可以了解一下2021-07-07
Dubbo在Spring和Spring Boot中的使用详解
这篇文章主要介绍了Dubbo在Spring和Spring Boot中的使用详解,需要的朋友可以参考下2017-10-10
这篇文章主要给大家介绍了关于Java系统中拆分同步和异步的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用Java具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧2019-06-06
Springboot国际化可以帮助使用者在不同语言环境中构建应用程序，这样应用程序可以有效地适应不同语言文化背景下的用户需求。本文主要介绍了SpringBoot实现前后端分离国际化的方法，需要的可以参考一下2023-02-02
mybatis 自定义实现拦截器插件Interceptor示例
这篇文章主要介绍了mybatis 自定义实现拦截器插件Interceptor，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-10-10
这篇文章主要介绍了Java中CyclicBarrier 循环屏障，可以实现让一组线程等待至某个状态屏障点之后再全部同时执行，下面文章分享CyclicBarrier循环屏障的原理，需要的小伙伴可以参考一下2022-05-05
这篇文章主要介绍了关于解决雪花算法生成的ID传输前端后精度丢失问题,雪花算法生成的ID传输到前端时，会出现后三位精度丢失,本文提供了解决思路,需要的朋友可以参考下2023-03-03
这篇文章主要介绍了java 中equals和==的区别，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2019-03-03
最新评论