spring接口文档注解:@ApiOperation
如下如代码截图:
@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请求内容等)高质量地创建这份文档本身就是一件复杂的事情。
  • 随着时间的前进和技术的推移,不断修改接口实现的时候都必须同步修改接口文档,而接口文档和代码又处于不同时空的两个地方。

相关文章:

  • 2022-12-23
  • 2021-11-27
  • 2021-11-07
  • 2022-12-23
  • 2022-12-23
  • 2021-05-17
  • 2021-12-04
猜你喜欢
  • 2022-12-23
  • 2021-07-31
  • 2022-12-23
  • 2022-12-23
  • 2022-12-23
相关资源
相似解决方案