1. 概述

Knife4j是一个用于生成和展示API文档的工具，同时它还提供了在线调试的功能，下图是其工作界面。

* Knife4j有多个版本，最新版的Knife4j基于开源项目`springdoc-openapi`，这个开源项目的核心功能就是根据SpringBoot项目中的代码自动生成符合OpenAPI规范的接口信息。
* OpenAPI规范定义接口文档的内容和格式，其前身是`Swagger`规范。 

2. 与springboot集成 

1.创建maven项目 

2.导入依赖

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

 3.创建配置类

@Configuration
public class Knife4jConfiguration {@Beanpublic OpenAPI openAPI() {return new OpenAPI().info(new Info().title("hello-knife4j项目API").version("1.0").description("hello-knife4j项目的接口文档"));}@Beanpublic GroupedOpenApi userAPI() {return GroupedOpenApi.builder().group("用户信息管理").pathsToMatch("/user/**").build();}@Beanpublic GroupedOpenApi systemAPI() {return GroupedOpenApi.builder().group("产品信息管理").pathsToMatch("/product/**").build();}
}

4.启动SpringBoot项目，访问http://localhost:8080/doc.html，观察接口文档。

 

3. 常用注解

@Schema`注解用于描述作为接口参数或者返回值的实体类的数据结构。

@Data
@Schema(description = "用户实体类")
public class User {@Schema(description = "用户id")private Integer id;@Schema(description = "用户姓名")private String name;
}

 

@Tag注解用于对接口进行分类，相同`Tag`的接口会放在同一个菜单。

@Operation用于对接口进行描述。

@Parameter用于对HTTP请求参数进行描述

@RestController
@RequestMapping("/user")
@Tag(name = "用户信息管理") //@Tag给该类起标题：用于描述该类
public class UserController {@GetMapping("/getId")@Operation(summary = "根据ID查询用户信息") //@Operation 属性summary：用与说明该方法的作用public User getById(@Parameter(description = "用户ID") @RequestParam("id") Integer id) {User user = new User();user.setId(id);return user;}
}