@ApiOperation是什么?spring接口文档注解:@ApiOperation

spring接口文档注解:@ApiOperation
如下如代码截图:
在这里插入图片描述
@ApOperation不是spring自带的注解是swagger里面的com.wordnik.swagger.annotations.ApiOperation;
详细介绍:
@ApiOperation和@ApiParam为添加的API相关注解,个参数说明如下:
@ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response = “接口返回参数类型”, notes = “接口发布说明”;其他参数可参考源码;
@ApiParam(required = “是否必须参数”, name = “参数名称”, value = “参数具体描述”

扩展和前言:

  • 实际项目中非常需要写文档,提高Java服务端和Web前端以及移动端的对接效率。
  • 由于我们在开发中接口众多而且细节复杂(需要考虑不同的HTTP请求类型,HTTP头部信息,HTTP请求内容等)高质量地创建这份文档本身就是一件复杂的事情。
  • 随着时间的前进和技术的推移,不断修改接口实现的时候都必须同步修改接口文档,而接口文档和代码又处于不同时空的两个地方。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值