SpringBoot3.4整合Knife4j

### SpringBoot 3.4 整合 Knife4j 示例教程 在Spring Boot 3.4中整合Knife4j，可以实现API文档的增强展示和交互功能。以下是一个完整的配置指南和示例代码。 #### 1. 添加依赖 在`pom.xml`文件中添加Knife4j的Maven依赖： ```xml <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>4.1.0</version> </dependency> ``` 确保版本与Spring Boot兼容[^4]。 #### 2. 配置application.yml 在`application.yml`中添加Knife4j的相关配置： ```yaml spring: application: name: knife4j-demo knife4j: enable: true swagger: enable: true ``` 此配置启用了Knife4j和Swagger的功能[^5]。 #### 3. 创建Swagger配置类 创建一个配置类以初始化Swagger和Knife4j： ```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.documentation.spring.web.plugins.Docket; @Configuration @EnableKnife4j public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.OAS_30) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Spring Boot 3.4 + Knife4j API 文档") .description("这是一个基于Spring Boot 3.4和Knife4j的API文档示例") .version("1.0.0") .build(); } } ``` 上述代码通过`@EnableKnife4j`注解启用了Knife4j，并定义了API的基本信息和扫描路径[^6]。 #### 4. 启动项目并访问文档 启动Spring Boot项目后，访问以下URL即可查看增强后的API文档界面： - **Swagger UI**: `http://localhost:8080/doc.html` - **Knife4j 增强版**: `http://localhost:8080/swagger-ui/index.html` Knife4j会自动增强Swagger UI的功能，提供更美观的界面和更丰富的交互选项[^7]。 --- ### 注意事项 - 确保Spring Boot版本为3.4，并且依赖版本与之兼容。 - 如果项目中已经集成了其他API文档工具（如Springfox），需要检查是否存在冲突并调整配置。 ---