江苏龙网

  1. 首页 > 人文 > >

Swagger2—API文档框架（二）( 二 )


4、ApiModel
@ApiModel是类上注解 ， 主要应用Model ， 也就是说这个注解一般都是写在实体类上 。
● value：名称
● description：描述
代码示例：
Swagger2—API文档框架（二）文章插图
swagger-ui.html效果展示
Swagger2—API文档框架（二）文章插图
5、ApiModelProperty
@ApiModelProperty可以用在方法或属性上 。 用于当对象作为参数时定义这个字段的内容 。
● value：描述
● name：重写属性名
● required：是否是必须的
● example：示例内容
● hidden：是否隐藏 。
代码示例：
Swagger2—API文档框架（二）文章插图
swagger-ui.html效果展示
Swagger2—API文档框架（二）文章插图
6、ApiIgnore
@ApiIgnore用于方法或类或参数上 ， 表示这个方法或类被忽略 。 和之前讲解的自定义注解@NotIncludeSwagger效果类似 。 只是这个注解是Swagger内置的注解 ， 而@NotIncludeSwagger是我们自定义的注解 。
7、ApiImplicitParam
@ApiImplicitParam用在方法上 ， 表示单独的请求参数 ， 总体功能和@ApiParam类似 。
● name：属性名
● value：描述
● required：是否是必须的
● paramType：属性类型
● dataType：数据类型
代码示例：
Swagger2—API文档框架（二）文章插图
swagger-ui.html效果展示
Swagger2—API文档框架（二）文章插图
如果希望在方法上配置多个参数时 ， 使用@ApiImplicitParams进行配置 。 示例如下：
Swagger2—API文档框架（二）文章插图
海量Java学习资料 ， 大厂面试题 ， 项目练习题 ， 统统免费提供 ， 只要关注 ， 那就会有收获~笔芯~


推荐阅读


上一篇：电竞显示器怎么选？可以来看看MSI MAG251RX

下一篇：vivo折叠屏专利曝光 铰链处藏笔设计有新意