RuoYi-Cloud3.5.0参照官方文档整合knife4j打不开问题处理或者是空白页的问题

本文介绍了如何在Ruoyi项目中集成knife4j,包括添加依赖、前端UI资源引入及解决路由问题。重点在于Spring Boot应用中使用Knife4j生成API文档和配置前端界面的方法,以及如何处理路由分组问题以确保文档正常显示。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1、在ruoyi-common-swagger引用knife4j-spring-boot-starter依赖。

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

2、在网关聚合文档服务下,把前端的ui资源引入。即在ruoyi-gateway引用knife4j-spring-ui依赖

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

3、测试验证

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

特别注意:

        可能你进入这个界面后是可空白的页面,不要慌!不要慌!不要慌!

启动ruoyi-gen再次访问,发现可以了,其实是因为第一个分组是ruoyi-gen的,所以是空白页面。

解决办法:

        去nacos修改ruoyi--gateway-dev.yml这个配置文件将routes下的id为ruoyi-system提到首位置就行了,这时候knife4j默认打开的分组是ruoyi-system,因为ruoyi-system是必启动的,所以就不会出现问题了。

    routes:
        # 系统模块
        - id: ruoyi-system
          uri: lb://ruoyi-system
          predicates:
            - Path=/system/**
          filters:
            - StripPrefix=1
        # 认证中心
        - id: ruoyi-auth
          uri: lb://ruoyi-auth
          predicates:
            - Path=/auth/**
          filters:
            # 验证码处理
            - CacheRequestFilter
            - ValidateCodeFilter
            - StripPrefix=1

### 将 Knife4j 集成RuoYi-Cloud-Plus 项目 #### 添加依赖项 为了使 Knife4j 能够正常工作,在 `pom.xml` 文件中添加以下 Maven 依赖: ```xml <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>3.0.3</version> </dependency> ``` 此操作确保了Knife4j能够作为Swagger增强工具被引入并运行于Spring Boot环境中[^1]。 #### 修改配置文件 编辑 `application.yml` 或者 `bootstrap.yml` 文件来启用 Knife4j 的相关设置: ```yaml spring: application: name: ruoyi-gateway swagger: enabled: true title: API 文档 description: 使用Knife4j展示API接口说明 version: "v1" termsOfServiceUrl: http://localhost:8766/doc.html contactName: Admin contactUrl: https://github.com/your-repo license: Apache License Version 2.0 licenseUrl: http://www.apache.org/licenses/ ``` 这些配置使得应用程序启动时自动加载并初始化Swagger UI界面以及关联的文档描述信息[^2]。 #### 创建 SwaggerConfig 类 创建一个新的 Java 类用于自定义 Swagger 和 Knife4j 设置。这一步骤对于定制化UI样式、分组管理等高级特性尤为重要。 ```java import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documenta
评论 5
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值