注解02:@Api 注解说明

最近学习springboot遇到些问题,百度之后总结记录一下

1. @Api: 用在请求的类上,表示对类的说明

  • tags="说明该类的作用,可以在前台界面上看到的注解"
  • value="该参数无意义,在UI界面上看不到,不需要配置"

2. @ApiModelProerty:用在属性上,面熟响应类的属性

3. @ApiModel: 用在响应类上,表示一个返回响应数据的信息

  • 一般用在post 创建,使用@RequestBody的时候
  • 请求参数无法使用@ApiImplicitParam

4. @ApiResponses: 用在请求的方法上,表示一组响应

5. @ApiResponse: 用在@ApiResponses 中,一般用于表达一个错误的响应信息

  • code: 数字代码
  • message: 信息,例:"操作失败"
  • response:抛出异常的类

6. @ApiImplicitParams:用在请求的方法上,表示一组参数说明

7. @ApiImplicitParam: 用在@ApiImplicitParams 注解中,指定一个请求参数的各个方面

  • name: 参数名
  • value: 参数的说明、解释
  • required: 是否必须传参
  • paramType:参数放什么位置
  • dataType: 参数类型,默认String,其它值dataType="Integer"
  • defaultValue: 参数的默认值

 

  • 7
    点赞
  • 29
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值