[尚庭公寓]07-Knife快速入门

Knife快速入门

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

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

与SpringBoot的集成相对简单，具体操作如下

创建SpringBoot项目
引入Maven 依赖
com.github.xiaoymin knife4j-openapi3-jakarta-spring-boot-starter 4.3.0
创建配置类

创建`com.atguigu.helloknife4j.config.Knife4jConfiguration`，内容如下

复制代码

@Configuration
public class Knife4jConfiguration {

    @Bean
    public OpenAPI openAPI() {
        return new OpenAPI()
        .info(new Info()
              .title("hello-knife4j项目API")
              .version("1.0")
              .description("hello-knife4j项目的接口文档"));
    }

    @Bean
    public GroupedOpenApi userAPI() {
        return GroupedOpenApi.builder().group("用户信息管理").
        pathsToMatch("/user/**").
        build();
    }

    @Bean
    public GroupedOpenApi systemAPI() {
        return GroupedOpenApi.builder().group("产品信息管理").
        pathsToMatch("/product/**").
        build();
    }
}

启动项目

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

Knife4j的使用也十分简单，我们只需使用几个简单注解，对接口进行描述，Knife4j就能自动生成API文档了。具体操作如下

描述实体类

创建`com.atguigu.helloknife4j.entity.User`，内容如下

复制代码

@Data
@Schema(description = "用户信息实体")
public class User {

    @Schema(description = "编号")
    private Long id;

    @Schema(description = "用户姓名")
    private String name;

    @Schema(description = "用户年龄")
    private Integer age;

    @Schema(description = "用户邮箱")
    private String email;
}

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

描述Controller接口

创建`com.atguigu.helloknife4j.controller.HelloController`，内容如下

复制代码

@RestController
@RequestMapping("/user")
@Tag(name = "用户信息管理")
public class HelloController {


    @Operation(summary = "根据id获取用户信息")
    @GetMapping("getById")
    public User getUserById(@Parameter(description = "用户id") @RequestParam Long id) {
        User user = new User();
        user.setId(id);
        user.setName("zhangsan");
        user.setAge(11);
        user.setEmail("zhangsan@email.com");
        return user;
    }
}

知识点：

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

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

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