springboot3整合knife4j详细版，包会！（不带swagger2玩）

Spring Boot 3整合Knife4j详细教程

在微服务架构中，API文档的管理至关重要。Knife4j 是 Swagger 的一个扩展，旨在提供更友好的用户界面和更佳的用户体验。本文将详细介绍如何在 Spring Boot 3 项目中整合 Knife4j，实现 API 文档的生成。

一、项目依赖

首先，我们需要在 pom.xml 文件中添加 Knife4j 相关的依赖。不使用 Swagger 2，我们只需添加 Knife4j 的核心依赖。假设您已经创建了一个 Spring Boot 3 项目，接下来在 pom.xml 中添加以下内容：

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

请注意，在添加依赖时，请确保查阅 Knife4j 的 GitHub 仓库 获取最新版本。

二、配置Knife4j

接下来，在 application.properties 或 application.yml 中进行简单的配置信息：

knife4j.enable=true
knife4j.group-config[0].name=示例分组
knife4j.group-config[0].url=/v3/api-docs/
knife4j.group-config[0].base-path=/**

这段配置的意思是启用 Knife4j，自定义分组名称和 API 文档的访问路径。

三、创建API接口

为了生成 API 文档，我们需要定义一些控制器。这里给出一个简单的示例：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;

@Api(tags = "用户接口")
@RestController
public class UserController {

    @ApiOperation(value = "获取用户信息", notes = "根据用户ID获取用户详细信息")
    @GetMapping("/api/user/{id}")
    public User getUserById(@PathVariable Long id) {
        // 假设这里是从数据库中获取用户信息
        return new User(id, "张三", 25);
    }
}

这里我们创建了一个简单的 UserController，并在其中定义了一个用于获取用户信息的 API 接口。我们使用 @Api 和 @ApiOperation 注释来描述这个接口。注意，这里直接使用了 User 类，您需要根据实际情况定义这个类。

public class User {
    private Long id;
    private String name;
    private Integer age;

    public User(Long id, String name, Integer age) {
        this.id = id;
        this.name = name;
        this.age = age;
    }

    // 省略setter和getter
}

四、访问API文档

启动您的 Spring Boot 应用程序后，访问以下地址：

http://localhost:8080/doc.html

您将看到 Knife4j 提供的图形化界面，能够方便地查看和测试您的 API。

五、总结

通过以上的步骤，我们成功地将 Knife4j 集成到 Spring Boot 3 项目中，并配置了一些 API 文档。与 Swagger 2 相比，Knife4j 提供了更友好的界面和更优雅的体验，非常适合微服务项目的 API 文档管理。

在实际开发中，我们可以根据多种需求进一步配置 Knife4j，例如自定义接口分组、版本管理等。希望这篇文章能够为您在 Spring Boot 项目中使用 Knife4j 提供一些帮助！如有问题，欢迎交流和讨论。