第五节 升级若依框架微服务版的Swagger

亮子 2025-08-09 12:04:22 183 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、修改根目录下pom文件如下

  • 添加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>

5、修改ruoyi-common工程pom文件

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

image.png

6、修改ruoyi-gateway

  • 修改pom文件,增加下面依赖,并且要放到最上面

(1) 添加依赖

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

<!-- Knife4j Gateway Spring Boot Starter-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-gateway-spring-boot-starter</artifactId>
</dependency>

image.png

(2)删除依赖

<!-- Springdoc -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-webflux-ui</artifactId>
    <version>${springdoc.version}</version>
</dependency>

image.png

  • 删除配置类

image.png

  • 修改yml文件
# knife4j 网关聚合配置
knife4j:
  enable: true
  production: false
  basic:
    enable: false
  gateway:
    enabled: true
    # 指定服务发现的模式聚合微服务文档
    strategy: discover
    discover:
      enabled: true
      # 指定版本号(OpenAPI3)
      version: openapi3
      # 需要排除的微服务(网关服务本身)
      excluded-services:
        - ruoyi-gateway
        - ruoyi-auth

image.png

# Spring
spring: 
  application:
    # 应用名称
    name: ruoyi-gateway
  profiles:
    # 环境配置
    active: dev
  main:
    web-application-type: reactive

image.png

  • 修改nacos服务器上的yml配置文件
  # 不校验白名单
  ignore:
    whites:
      - /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

image.png

7、运行测试

image.png