Swagger(三) Swagger中常用的注释

本文详细介绍了@Api、@ApiOperation和@ApiModel三个Springfox注解的使用方法及应用场景,帮助开发者更好地理解如何通过这些注解来描述RESTful API接口,提高API文档的可读性和维护性。
摘要由CSDN通过智能技术生成
  1. @Api:用在请求的类上,表示对类的说明
    tags=“说明该类的作用,可以在UI界面上看到的注解”
    description =“描述”
    比如:
@Api(tags = "第一个Controller层",description = "用来测试数据")

2.@ApiOperation:用在请求的方法上,说明方法的用途、作用
value=“说明方法的用途、作用”
notes=“方法的备注说明”

@ApiOperation(value = "Hello",notes = "返回一个hello")

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

  @ApiModel("用于封装后台放回结果,规定一个数据结构")
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

MW0309

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值