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





