【knife4j】springboot2集成knife4j+自动生成接口文档。灰常简单！！！

目录

一、springboot2集成knife4j

二、通过knife4j生成接口文档

---

 前言：

        1.若依官网文档中是有集成knife4j的文档的，链接：系统接口 | RuoYi

        2.idea安装插件 Swagger Tools(作用是可以帮我们快速生成swagger所需要的注解)                             安装+使用方法查看：使用IDEA swagger tools 根据文档注释批量生成@ApiModelProperty-CSDN博客

一、springboot2集成knife4j

1.在ruoyi-gateway网关模块下，把knife4j依赖资源引入

<!-- knife4j -->
<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>knife4j-spring-ui</artifactId>
	<version>3.0.3</version>
</dependency>
<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>knife4j-spring-boot-starter</artifactId>
	<version>3.0.3</version>
</dependency>

 2.在ruoyi-common-swagger系统接口模块下，把knife4j依赖资源引入。

        不同人不同类名，跑不了XXX-common-swagger。

<!-- knife4j -->
<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>knife4j-spring-boot-starter</artifactId>
	<version>3.0.3</version>
</dependency>

3、在其他ruoyi-xxxx-xxxx服务下，把ruoyi-common-swagger依赖资源引入 

<!-- RuoYi Common Swagger -->
<dependency>
	<groupId>com.ruoyi</groupId>
	<artifactId>ruoyi-common-swagger</artifactId>
</dependency>

 4、在SwaggerProvider.java的类注解追加@Primary

  这一步是非必须，因为@Primary是解决依赖注入时的歧义问题，在有多个相同bean时，Spring会优先选择带有@Primary注解的bean进行注入。所以咱们可以Ctrl+F全局搜索查看项目中有几个SwaggerProvider类，一个的话不用注解，两个或多个在你想用的类名（bean前）前加上@Primary。

5、测试验证

      访问http://{ip}:{port}/doc.html地址，出现如下图表示成功。

二、通过knife4j生成接口文档

 打开文档，认真检查接口 数据 返回值 等是否有误。

如有错误，敬请雅正！