Spring Boot 整合 Knife4j（快速上手）

关于 Knife4j

官方文档：https://doc.xiaominfo.com/

Knife4j是一个基于Swagger的API文档生成工具，它提供了一种方便的方式来为Spring Boot项目生成在线API文档。Knife4j的特点包括：

• 自动化生成：通过Swagger注解，Knife4j可以自动解析API接口并生成对应的文档页面，无需手动编写文档。
• 在线编辑和展示：Knife4j提供了在线编辑API文档的功能，可以方便地查看和测试API接口。
• 可定制性：可以根据项目需求定制文档的展示样式和内容，满足不同项目的需求。
• 方便集成：通过Spring Boot Starter的方式，可以方便地集成到Spring Boot项目中，无需额外的配置。

总之，Knife4j是一个方便、灵活且功能丰富的API文档生成工具，可以帮助开发团队快速生成和维护API文档。

整合 Knife4j

添加 Knife4j 依赖

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

配置 Knife4j 文档

第一种方式：Java 配置类

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {
   

    private ApiInfo commonApiInfo() {
   
        return new ApiInfoBuilder()
                .title("knife4j 接口文档测试")
                .description("Knife4j是一款基于Swagger的API文档在线编辑工具，它为Java开发人员提供了一种简单而强大的方式来创建、编辑和管理API文档。Knife4j可以帮助开发人员快速生成和展示API文档，提供了友好的界面和丰富的功能，包括接口测试、在线调试、文档管理等。它还支持对Swagger注解的解析，能够自动生成API文档，并提供了一些扩展功能，如接口权限设置、数据模型展示等。Knife4j可以帮助开发团队更好地管理和维护API文档，提高开发效率和协作能力。")
                .contact("hwike@foxmail.com")
                .version