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

Knife快速入门

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

  • Knife4j有多个版本,最新版的Knife4j基于开源项目`springdoc-openapi`,这个开源项目的核心功能就是根据SpringBoot项目中的代码自动生成符合OpenAPI规范的接口信息。

  • OpenAPI规范定义接口文档的内容和格式,其前身是`Swagger`规范。

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

  1. 创建SpringBoot项目

  2. 引入Maven 依赖

    <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId> <version>4.3.0</version> </dependency>
  3. 创建配置类

创建`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();
    }
}
  1. 启动项目

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

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

  1. 描述实体类

创建`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`注解用于描述作为接口参数或者返回值的实体类的数据结构。

  1. 描述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请求参数进行描述

相关推荐
巴厘猫18 分钟前
Java开发者新机遇:LangChain4j——在Java中构建LLM应用的利器
java·后端·langchain
Your易元22 分钟前
设计模式-访问者模式
java·开发语言
巴厘猫22 分钟前
拥抱智能时代:Spring AI:在Spring生态中构建AI应用——深度剖析与实践
java·spring
loop lee23 分钟前
【Spring】一文了解SpringMVC的核心功能及工作流程,以及核心组件及注解
java·后端·spring
Resean022326 分钟前
SpringMVC 6+源码分析(一)初始化流程
java·后端·spring·servlet·springmvc
MacroZheng37 分钟前
扔掉HttpUtil!看看人家的HTTP客户端工具,那叫一个优雅!
java·spring boot·后端
Chase_______37 分钟前
redis快速入门及使用
java·数据库·redis·学习·spring·缓存
是Dream呀38 分钟前
速度与精度的结合:Faster R-CNN模型的性能剖析
开发语言·r语言·cnn
wait a minutes41 分钟前
【c++】leetcode763 划分字母区间
开发语言·c++
〃冷·夏ぐ1 小时前
Java内存模型(JMM)
java·开发语言