Spring Boot 整合 Knife4j 实现 API 文档生成是一个很常见的需求，这样可以方便地为接口提供文档，便于开发者进行接口调试和维护。Knife4j 是对 Swagger 的一个增强，可以提供更加丰富的 API 文档功能。以下是整合的基本步骤：

环境准备

1. 创建一个 Spring Boot 项目：可以使用 Spring Initializr 生成项目框架，选择 Spring Web 依赖。

2. 添加依赖：在 pom.xml 或者 build.gradle 中添加 Swagger 和 Knife4j 相关依赖。

对于 Maven 项目，你需要添加以下依赖：

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

配置 Swagger 和 Knife4j

1. 创建配置类：在 src/main/java 下创建一个配置类 Knife4jConfiguration.java。

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;  
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;  
@Configuration  
@EnableSwagger2WebMvc  
public class Knife4jConfiguration {  
    @Bean(value = "defaultApi2")  
    public Docket defaultApi2() {  
        Docket docket = new Docket(DocumentationType.SWAGGER_2)  
                .apiInfo(apiInfo())  
                .select()  
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))  
                .paths(PathSelectors.any())  
                .build();  
        return docket;  
    }  
    private ApiInfo apiInfo() {  
        return new ApiInfoBuilder()  
                .title("API文档")  
                .description("API文档描述")  
                .version("1.0")  
                .build();  
    }  
}  

请确保将 basePackage 修改为您实际项目的包路径。

启动项目并查看文档

1. 启动 Spring Boot 应用：运行应用后，通过浏览器访问 http://localhost:8080/doc.html 查看 Knife4j 提供的 API 文档页面。

2. 使用文档：在这个页面上，你可以看到所有接口的详细信息，包括请求方式、参数、响应等。

进一步自定义

• 分组管理：可以在配置多个 Docket bean 来实现接口分组。
• 接口注释：使用 Swagger 的注解，如 @ApiOperation，@ApiParam等，为接口和参数提供详细说明。

常见问题

• 接口看不到：确保接口的注解和路径设置正确，并且项目没有安全设置限制访问。
• 版本兼容性：Knife4j 和 Springfox 的版本需要和 Spring Boot 兼容，确保使用的版本相匹配。

通过这样的方法，你可以很轻松地在 Spring Boot 项目中集成 Knife4j 来生成和管理 API 文档。