Swagger与Knife4j：日常开发的使用

偏执的太偏执、 2023-09-29 11:11 7阅读 0赞

> **我是 ABin-阿斌：写一生代码，创一世佳话，筑一览芳华。 如果小伙伴们觉得我的文章不错，记得一键三连，感谢~**  
> ![在这里插入图片描述][01244a35a05f9070bf77418374331efc.png_pic_center]

### 文章目录 ###

*  前言
 *  注解介绍与使用
 *   *  页面展示：
     *  Swagger常用注解
     *  KnIfe4j注解

# 前言 #

*  在日常开发当中我们少不了用 **Swagger** 的注解，下面我就粗略讲一下我们日常开发当中比较常用的一些注解吧，同时项目当中配合使用：**knife4j** 对于联调接口来说是一个非常不错的体验。

# 注解介绍与使用 #

## 页面展示： ##

*  这里用的版本是： **Swagger：3.0.0 Knife4j：3.0.3**，对于 **Knife4j** 不熟悉同学可以去 **github** 直接搜这个了解一下
 *  使用 **Knife4j** 后的可视化界面

![在这里插入图片描述][24021747f2c3cb113f1dfef32d97768f.png_pic_center]

## Swagger常用注解 ##

*  **@ApiOperation( )：** 标注当前控制器接口的作用
 *  **@ApiImplicitParams（\{@ApiImplicitParam()，… \}）：** 用于为：GET请求接口的参数解释
 *  **@ApiModelProperty( ）：** 标注类参数名
 *  **Swagger 详细的原理可以看我这篇文章：** https://blog.csdn.net/Mango\_Bin/article/details/115679246

![在这里插入图片描述][5a920325ede5eb28c66693758fe80445.png_pic_center]  
![在这里插入图片描述][31a5d1be1a74885812c1f3c422e463c9.png_pic_center]

## KnIfe4j注解 ##

*  **@ApiOperationSupport(author = “xxxxx”)：** 标注改接口是谁写的，便于前端人员联调接口时遇到问题可以直接找到开发人员
 *  **Knlfe4j 框架的具体介绍：** https://www.techgrow.cn/posts/e2246230.html

![在这里插入图片描述][29355bdbdb9d62aa3e6ebfcfd0654261.png_pic_center]

[01244a35a05f9070bf77418374331efc.png_pic_center]: https://img-blog.csdnimg.cn/img_convert/01244a35a05f9070bf77418374331efc.png#pic_center
[24021747f2c3cb113f1dfef32d97768f.png_pic_center]: https://img-blog.csdnimg.cn/img_convert/24021747f2c3cb113f1dfef32d97768f.png#pic_center
[5a920325ede5eb28c66693758fe80445.png_pic_center]: https://img-blog.csdnimg.cn/img_convert/5a920325ede5eb28c66693758fe80445.png#pic_center
[31a5d1be1a74885812c1f3c422e463c9.png_pic_center]: https://img-blog.csdnimg.cn/img_convert/31a5d1be1a74885812c1f3c422e463c9.png#pic_center
[29355bdbdb9d62aa3e6ebfcfd0654261.png_pic_center]: https://img-blog.csdnimg.cn/img_convert/29355bdbdb9d62aa3e6ebfcfd0654261.png#pic_center