Swagger注解学习

1.什么是Swagger
OpenAPI规范(OpenAPI Specification 简称OAS)是Linux基金会的一个项目,试图通过定义一种用来描述API格式或API定义的语言,来规范RESTful服务开发过程,目前版本是V3.0,并且已经发布并开源在github上。

Swagger是符合OpenAPI规范的接口开发工具,支持从设计和文档到测试和部署的整个API生命周 期的开发

@ApiOperation

  1. 首先@ApiOperation注解不是Spring自带的,它是是swagger里的
  2. 注解@ApiOperation是用来构建Api文档的
  3. @ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response =
    “接口返回参数类型”, notes = “接口发布说明”;其他参数可参考源码

@ApiModelProperty 

它的作用是添加和操作属性模块的数据

参考:@ApiModelProperty注解的用法(官方平台推荐文章)_我有一只小阿茶的博客-CSDN博客_@apimodelproperty

@ApiModel

使用场景:在实体类上边使用,标记类时swagger的解析类

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值