SpringBoot整合knife4j(若依框架版)

整了一天knife4j!都一直报错,最后成功做出,这里给大家分享一下过程,避免大家踩坑

1.添加依赖

1.1父级依赖

楼主这里把ruoyi改成自己的名字了,大家把前缀的qyq当做成ruoyi即可

在依赖中引入这些

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

            <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-spring-boot-starter</artifactId>
                <version>${knife4j.version}</version>
            </dependency>

1.2公共依赖(ruoyi-common-swagger)

在我画圈的这个包的依赖中,引入以下:

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

1.3 ruoyi-gateway

在我画圈的这个包的依赖中,引入以下:

		<dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
        </dependency>
		
		<dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-micro-spring-boot-starter</artifactId>
        </dependency>

随后在我圈出的类中,加一个注解

@Primary

2.打开若依的前台

根据红圈 一一打开,然后点击修改

这里的8080指的是后台网关的端口号

3 修改配置ruoyi-gateway-dev.yml

前往nacos的配置中心，编辑ruoyi-gateway-dev.yml

点进去后,将路由id为ruoyi-system的节点放在最前面(如果想测自己的,下面会讲)

4 效果

重启一下所有服务，访问http://localhost:你的网关端口号/doc.html#/home,或从系统工具菜单的系统接口进入文档管理页面，增强后的文档管理界面如下：

5.访问自己的服务

http://127.0.0.1:****/doc.html#/home

直接访问以上的网站即可(复制下来将*号改成自己的网关端口号)

6.报错解决

在启动时发现这个问题

引入swagger 出现 Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException 问题的可能解决方案

在启动类上添加注解@EnableCustomSwagger2 即可

@EnableCustomSwagger2

随后启动就可以了