关于Swagger中的注解

一、@ApiModel 用于实体类上,value 值为类名,description 为类的描述

@ApiModel(value = "User", description = "用户信息")

在这里插入图片描述

二、@ApiModelProperty 用于方法,字段, 表示对model属性的说明或者数据操作更改
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏
在这里插入图片描述
三、@Api 用于controller类上
value - 字段说明
description - 注释说明这个类
在这里插入图片描述
四、@ApiOperation 用于方法上
value - 接口说明
httpMethod - 接口请求方式
response - 接口返回参数类型
notes - 接口发布说明
默认值为value
在这里插入图片描述

五、@ApiParam 用于方法的参数上
required - 是否必须参数
name - 参数名称
value = “参数具体描述

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值