Swagger和Knife4j 接口文档

原创

已于 2024-06-30 21:10:39 修改 · 967 阅读

于 2024-04-21 16:13:35 首次发布

接口文档是什么？

当涉及到后端开发时，接口文档是非常重要的。接口文档是对系统中各种接口的定义、描述和说明的文档。这些接口可以是应用程序之间的通信接口，也可以是前端与后端之间的交互接口。

接口文档通常包括以下内容：

接口的名称和描述：每个接口的名称和简要描述，以便开发人员了解其作用。
请求参数：描述每个接口所需的请求参数，包括参数名称、数据类型、是否必需等信息。
响应参数：描述每个接口返回的参数，包括参数名称、数据类型等信息。
接口示例：提供一些示例请求和响应，帮助开发人员更好地了解接口的使用方式。
接口调用规则：指定如何调用接口，例如请求方式（GET、POST等）、请求地址、认证方式等。

接口文档一般是后端开发人员写的。

常见的接口文档工具:

常见的接口文档工具包括Swagger、Postman、Apiary等，它们提供了友好的界面和便捷的功能，帮助开发人员管理和维护接口文档。

Swagger和Knife4j的介绍：

使用Swagger你只需要按照它的规范去定义接口及接口相关的信息，就可以做到生成接口文档，以及在线接口调试页面。官网：https://swagger.io/

Knife4j 是为Java MVC框架集成Swagger生成Api文档的增强解决方案。

Swagger和Knife4j的作用：

通过Swagger可以帮助后端生成接口文档，并且可以进行在线接口测试

因为Knife4j是Swagger，所以现在基本上也就是用Knife4j

Knife4j的基本使用：

依旧还是老规矩：先放一个Knife4j的官网

快速开始 | Knife4j (xiaominfo.com)

1：引入依赖：

在引入依赖之前，我们需要知道：

所以我们引入的依赖是：

            <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-spring-boot-starter</artifactId>
                <version>${knife4j}</version>
            </dependency>

2：在配置类中加入 knife4j 相关配置：

    /**
     * 通过knife4j生成接口文档
     * @return
     */
    @Bean
    public Docket docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("苍穹外卖项目接口文档")
                .version("2.0")
                .description("苍穹外卖项目接口文档")

标签