Swagger2—API文档框架(二)( 二 )
4、ApiModel
@ApiModel是类上注解 , 主要应用Model , 也就是说这个注解一般都是写在实体类上 。
● value:名称
● description:描述
代码示例:
文章插图
swagger-ui.html效果展示
文章插图
5、ApiModelProperty
@ApiModelProperty可以用在方法或属性上 。 用于当对象作为参数时定义这个字段的内容 。
● value:描述
● name:重写属性名
● required:是否是必须的
● example:示例内容
● hidden:是否隐藏 。
代码示例:
文章插图
swagger-ui.html效果展示
文章插图
6、ApiIgnore
@ApiIgnore用于方法或类或参数上 , 表示这个方法或类被忽略 。 和之前讲解的自定义注解@NotIncludeSwagger效果类似 。 只是这个注解是Swagger内置的注解 , 而@NotIncludeSwagger是我们自定义的注解 。
7、ApiImplicitParam
@ApiImplicitParam用在方法上 , 表示单独的请求参数 , 总体功能和@ApiParam类似 。
● name:属性名
● value:描述
● required:是否是必须的
● paramType:属性类型
● dataType:数据类型
代码示例:
文章插图
swagger-ui.html效果展示
文章插图
如果希望在方法上配置多个参数时 , 使用@ApiImplicitParams进行配置 。 示例如下:
文章插图
海量Java学习资料 , 大厂面试题 , 项目练习题 , 统统免费提供 , 只要关注 , 那就会有收获~笔芯~
- 程序员为教师妻子开发应用:将iPhone变成文档摄像头
- 飞书文档微信小程序审核被卡?字节跳动副总裁谢欣:希望腾讯停止无理由封杀
- 拜拜扫描仪!微信打开这个功能,文档表格扫一扫秒变电子档
- 字节跳动高管喊话腾讯,称“飞书文档”小程序审核被卡近两月
- DataPipeline亮相2020数据库技术大会,揽获「技术卓越奖」
- 微软悄然更新支持文档 Windows 10X确认支持Modern Standby
- 英特尔分析师日活动摘要:不放弃芯片制造业务 推动oneAPI软件平台发展
- 阿里P8级架构师十年心血终成Java核心精讲与网络协议文档;
- 爱了!Guide哥手把手教你搭建一个文档类型的网站!免费且高速
- Kotlin集合vs Kotlin序列与Java流