首页ruoyi-cloud-plus 集成knife4j

ruoyi-cloud-plus 集成knife4j

时间: 2025-03-27 21:12:45 浏览: 66

### 将 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

阅读全文