集成 Knife4j 实现 Swagger 文档增强

在若依项目中，可以通过集成 Knife4j 来增强 Swagger 文档的功能。Knife4j 是对 Swagger 的一个 UI 增强解决方案，提供了更加友好的界面、离线文档、接口排序、安全控制、在线调试等功能，使得接口文档的使用更加方便和直观。以下是详细的集成步骤：

1. 添加 Knife4j 依赖

首先，在 ruoyi-admin/pom.xml 文件中添加 Knife4j 的 Maven 依赖：

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

添加此依赖后，Knife4j 会自动在项目中替换 Swagger 的默认 UI，提供增强的界面。

2. 修改 Vue 项目中的 Swagger 页面跳转地址

为了让前端正确跳转到 Knife4j 的文档页面，需要在 ry-ui/views/tool/swagger/index.vue 文件中修改 Swagger 的跳转地址：

// 修改后的跳转地址
src: process.env.VUE_APP_BASE_API + "/doc.html",

process.env.VUE_APP_BASE_API 是指向后端 API 的基础路径，/doc.html 是 Knife4j 默认的文档页面地址。

3. 登录系统，验证集成效果

完成上述配置后，可以登录若依系统，访问 系统工具 -> 系统接口 菜单。如果成功集成 Knife4j，应该可以看到如下增强的接口文档界面。

4. 提示与建议

• 删除 Swagger 依赖：在集成 Knife4j 后，项目中的 Swagger 相关依赖可以删除，因为 Knife4j 已经包含了所有必要的 Swagger 功能，并且提供了增强的界面。

  如果需要删除 Swagger 依赖，请确保在 pom.xml 中去除相关的依赖声明：

  <!-- Swagger 依赖（可删除） -->
  <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
  </dependency>
  <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
  </dependency>
  

• 接口文档配置：集成 Knife4j 后，所有原有的 Swagger 配置依然有效，您可以继续使用 Swagger 注解来生成接口文档。Knife4j 仅仅是在 Swagger 的基础上提供了 UI 增强和更多的功能选项。

总结

通过上述步骤，您可以在若依项目中成功集成 Knife4j，并使用其增强的接口文档功能。Knife4j 不仅提供了更加美观的界面，还增强了文档的可读性和可操作性，使得开发人员和测试人员在使用 API 文档时更加得心应手。