ApiFox 基本使用教程（浅尝辄止，非广）

文章目录

概述

官网：https://www.apifox.cn/

ApiFox 集 API 文档、API 调试、API Mock、API 自动化测试 功能于一体，

Apifox = Postman + Swagger + Mock + JMeter

新建接口

在一个接口中，ApiFox 允许你添加以下部分：

• 接口名称、分组、状态、责任人、服务、标签、说明
• 请求方法（GET、POST、PATCH、PUT、DELETE、HEAD 等）
• 请求路径（比如 /hello/world/{world_id}?offset=0&limit=25）
• 请求参数（Query 与 Path）
• 请求体
• 请求头
• Cookie
• Auth
• SSL 设置、自动重定向
• 响应结果（返回结果）

请求方法

ApiFox 支持定义 GET、POST、PUT、DELETE、OPTIONS、HEAD、PATCH、TRACE、CONNECT、COPY、LINK、UNLINK、PURGE、LOCK、UNLOCK、MKCOL、MOVE、PROPFIND、REPORT、VIEW 方法。

请求路径 & 请求参数

请求路径中填写

ip:port

或

ip:port/project_name

之后的路径

在请求路径中，可以添加请求参数（Query Parameters）和路径参数（Path Parameters），例如

/hello/world/{world_id}?offset=0&limit=25

，其中的请求参数

offset

、

limit

与路径参数

world_id

都会在请求参数部分自动出现：

请求体

对于每个请求体中的字段，可以设置其数据类型、Mock 正则式、高级设置（如下图，可以设置默认值、枚举、数值范围等，可以通过编辑源码直接进行规则设置）：

请求头

可以对每个接口设置请求头字段

响应体

响应体的字段设置类似于请求体

接口测试

对于后端来说，其除了是接口文档外，还是接口测试工具（参考 Postman）。

自动生成合适的测试数据

我们可以像使用 Postman 一样在接口测试中添加 Params、Body、Headers 等测试数据，但是其强大在于我们可以根据在前文的「请求体」中设置的 Mock 正则、默认值、枚举等信息自动生成接口测试数据！

保存测试用例

不同于 Postman 以组为粒度，ApiFox 以每个具体的接口为粒度保存测试用例：

Mock

在后端还没写好接口时，前端需要使用一个假数据接口来进行前端页面的数据渲染测试工作，ApiFox 提供了这个 Mock 功能，并可以根据以上设置的规则自动生成合适 Mock 数据：