@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 = “参数具体描述”
扩展和前⾔:
百度api接口实际项⽬中⾮常需要写⽂档,提⾼Java服务端和Web前端以及移动端的对接效率。
由于我们在开发中接⼝众多⽽且细节复杂(需要考虑不同的HTTP请求类型,HTTP头部信息,HTTP请求内容等)⾼质量地创建这份⽂档本⾝就是⼀件复杂的事情。
随着时间的前进和技术的推移,不断修改接⼝实现的时候都必须同步修改接⼝⽂档,⽽接⼝⽂档和代码⼜处于不同时空的两个地⽅。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论