最完整版-Spring Boot 3集成Knife4j

引言

随着微服务架构的普及，API的文档化变得越来越重要。Spring Boot作为一种主流的Java后端开发框架，提供了优雅的解决方案。而Knife4j则是一个基于Swagger的API文档生成工具，它为开发者提供了更加友好的界面和丰富的功能。在这篇文章中，我们将详细介绍如何在Spring Boot 3项目中集成Knife4j。

环境准备

首先，我们需要确保已经安装好了Java和Maven。接下来，创建一个新的Spring Boot项目，可以使用Spring Initializr，也可以手动创建。

1. 创建Spring Boot项目

在pom.xml文件中，添加以下依赖：

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Knife4j -->
    <dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>knife4j-spring-boot-starter</artifactId>
        <version>3.0.4</version> <!-- 根据最新版本更新 -->
    </dependency>

    <!-- 其他依赖 -->
</dependencies>

2. 配置Knife4j

在application.yml文件中，添加Knife4j的配置。例如：

knife4j:
  enable: true
  group:
    - groupName: "默认分组"
      groupDesc: "API接口文档"
  contact:
    name: "开发者"
    url: "http://yourwebsite.com"
    email: "developer@example.com"

3. 创建API接口

在项目中创建一个简单的RESTful API：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello, Knife4j!";
    }
}

4. 配置Swagger

Knife4j是基于Swagger实现的，因此需要配置Swagger。我们可以创建一个配置类：

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapui;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapui
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example")) // 修改为你的基包
                .paths(PathSelectors.any())
                .build();
    }
}

5. 启动应用

现在，一切准备就绪，我们可以启动Spring Boot应用。使用以下命令启动：

mvn spring-boot:run

6. 访问API文档

启动应用后，访问以下地址即可查看Knife4j生成的API文档：

http://localhost:8080/doc.html

在页面中，你将看到列表中的API接口，以及详细的文档内容。

总结

本文介绍了如何在Spring Boot 3项目中集成Knife4j。通过简单的步骤，我们完成了Knife4j的配置，并创建了一个简单的RESTful API，最终生成了API文档。Knife4j的友好界面与强大功能，让API文档的查看与管理变得更加简单高效。

希望这篇文章能够帮助你快速上手Knife4j，提升你的开发效率！如果你有任何问题或建议，欢迎留言讨论。