开发喵星球

1、添加依赖

1.1 添加knife4j-spring-boot-starter依赖

位置：ruoyi-common-swagger系统接口模块中的pom.xml文件

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

1.2 添加 knife4j-spring-ui 依赖

位置：ruoyi-gateway网关模块的pom.xml文件

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

1.3 引入ruoyi-common-swagger依赖

在其他ruoyi-xxxx-xxxx服务下，把ruoyi-common-swagger依赖资源引入

<!-- RuoYi Common Swagger -->
<dependency>
    <groupId>com.ruoyi</groupId>
    <artifactId>ruoyi-common-swagger</artifactId>
</dependency>

2、修改配置文件

2.1 修改主配置文件

位置：nacos的ruoyi–gateway-dev.yml

操作：将配置文件中routes的id为ruoyi-system提到首位

原因：首位为knife4j默认打开的分组，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

3、访问页面验证是否成功

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

集成后地址从/swagger-ui/index.html 变成/doc.html

注意： 若访问 127.0.0.1:8080/doc.html 出现

{"code":500,"msg":"404 NOT_FOUND"}

访问http://localhost:8080/swagger-ui/index.html正常

需要yml文件中添加

knife4j:
  basic:          
      enable: true