第一章:升级若依框架微服务版的Swagger

李少 | 2025-12-11 22:40:36 | 156 | 0 | 0 | 0

1.克隆代码

git clone https://gitee.com/y_project/RuoYi-Cloud.git

2.替换网络IP

确保mysql,redis,nacos可用

image.png

3.修改为JDK1.8的编译环境

image.png

4.编译并运行必要项目

image.png

5.把依赖放到根目录

!!!#ff9900 添加knife4j版本!!!

<knife4j.version>4.4.0</knife4j.version>

image.png
添加knife4j依赖


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

6.## 修改ruoyi-common里的pom文件

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

image.png

7.修改ruoyi-gateway

修改pom文件,添加的依赖必须放到最上面

<dependency>
    <groupId>com.ruoyi</groupId>
    <artifactId>ruoyi-common-swagger</artifactId>
</dependency>


<dependency>
 <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-gateway-spring-boot-starter</artifactId>
    <!-- 补充对应的版本号,比如适配项目的版本 -->
    <version>4.4.0</version>
</dependency>

删除依赖
image.png

#8.删除配置类
image.png
这里
image.png

9.修改Swagger 文档(关键!)

	- id: ruoyi-order-api-docs
          uri: lb://ruoyi-order
          predicates:
            - Path=order/v3/api-docs

        - id: ruoyi-prod-api-docs
          uri: lb://ruoyi-prod
          predicates:
            - Path=/prod/v3/api-docs

image.png

修改yml文件
image.png

#10. 修改nacos服务器上的yml配置文件
image.png

- /auth/logout
      - /auth/login
      - /auth/register
      - /csrf
      - /doc.html
      - /doc.html/**
      - /v3/api-docs
      - /v3/api-docs/**
      - /*/v3/api-docs
      - /*/v3/api-docs/**
      - /swagger-resources
      - /swagger-resources/**
      - /webjars/**
      - /favicon.ico

11.运行测试

image.png