前言
- 在日常开发当中我们少不了用 Swagger 的注解,下面我就粗略讲一下我们日常开发当中比较常用的一些注解吧,同时项目当中配合使用:knife4j 对于联调接口来说是一个非常不错的体验。
Springboot 整合 Knife4j 教程
注解介绍与使用
页面展示:
- 这里用的版本是: Swagger:3.0.0 Knife4j:3.0.3,对于 Knife4j 不熟悉同学可以去 github 直接搜这个了解一下
- 使用 Knife4j 后的可视化界面
Swagger常用注解
- @ApiOperation( ): 标注当前控制器接口的作用
- @ApiImplicitParams({@ApiImplicitParam(),… }): 用于为:GET请求接口的参数解释
- @ApiModelProperty( ): 标注类参数名
- Swagger 详细的原理可以看我这篇文章: https://blog.csdn.net/Mango_Bin/article/details/115679246
KnIfe4j注解
- @ApiOperationSupport(author = “xxxxx”): 标注改接口是谁写的,便于前端人员联调接口时遇到问题可以直接找到开发人员
- Knlfe4j 框架的具体介绍: https://www.techgrow.cn/posts/e2246230.html