Apifox新手快速上手.pdf

Apifox快速上⼿

1、Apifox
定位

Apifox=Postman+Swagger+Mok+JMeter

Apifox
是
API
⽂档、API
调试、API
Mock、API
⾃动化测试⼀体化协作平台。

2、Apifox
功能

1.接⼝设计：Apifox
接⼝⽂档遵循
OpenApi
3.0
(原
Swagger)、JSON
Schema
规范的同时，提供了

⾮常好⽤的可视化⽂档管理功能，零学习成本，⾮常⾼效。并且⽀持在线分享接⼝⽂档。

2.数据模型：可复⽤的数据结构，定义接⼝返回数据结构及请求参数数据结构（仅
JSON
和
XML

模式）时可直接引⽤。⽀持模型直接嵌套引⽤，直接
JSON/XML
智能导⼊，⽀持
oneOf、allOf
等

⾼级组合模式。

3.接⼝调试：Postman
有的功能，⽐如环境变量、前置/后置脚本、Cookie/Session
全局共享
等功

能，Apifox
都有，并且⽐
Postman
更⾼效好⽤。接⼝运⾏完之后点击保存为⽤例按钮，即可⽣

成接⼝⽤例，后续可直接运⾏接⼝⽤例，⽆需再输⼊参数，⾮常⽅便。⾃定义脚本
100%
兼容

Postman
语法，并且⽀持运⾏
javascript、java、python、php、js、BeanShell、go、shell、

ruby、lua
等各种语⾔代码。

4.接⼝⽤例：通常⼀个接⼝会有多种情况⽤例，⽐如参数正确⽤例、参数错误⽤例、数据为空⽤

例、不同数据状态⽤例等等。运⾏接⼝⽤例时会⾃动校验数据正确性，⽤接⼝⽤例来调试接⼝⾮

常⾼效。

5.接⼝数据
Mock：内置
Mock.js
规则引擎，⾮常⽅便
mock
出各种数据，并且可以在定义数据结构

的同时写好
mock
规则。⽀持添加“期望”，根据请求参数返回不同
mock
数据。最重要的是

Apifox
零配置
即可
Mock
出⾮常⼈性化的数据，具体在本⽂后⾯介绍。

6.数据库操作：⽀持读取数据库数据，作为接⼝请求参数使⽤。⽀持读取数据库数据，⽤来校验(断

⾔)接⼝请求是否成功。

7.接⼝⾃动化测试：提供接⼝集合测试，可以通过选择接⼝（或接⼝⽤例）快速创建测试集。⽬前接

⼝⾃动化测试更多功能还在开发中，敬请期待！⽬标是：
JMeter
有的功能基本都会有，并且要更

好⽤。

8.快捷请求：类似
Postman
的接⼝调试⽅式，主要⽤途为临时调试⼀些⽆需⽂档化的接⼝，⽆需提

前定义接⼝即可快速调试。

9.代码⽣成：根据接⼝及数据数据模型定义，系统⾃动⽣成接⼝请求代码、前端业务代码及后端业务

代码。

10.团队协作：Apifox
天⽣就是为团队协作⽽⽣的，接⼝云端实时同步更新，成熟的团队/项⽬/成员

权限管理，满⾜各类企业的需求。

1.团队管理

1.1创建团队

创建⼀个开发团队，例如：（成丰产研中⼼）

1.2创建关联项⽬

创建团队管理的项⽬（例如：⽤⼾中⼼、油⽓平台），每个项⽬单独管理api接⼝

1.3邀请相关⼈员进⼊团队，并分配对应的管理权限

权限分为两部分：

a.团队权限

b.项⽬权限

2.API⽂档管理

2.1环境管理

根据现有环境，配置各个环境的url等参数，环境变量等

2.2接⼝⽂档设计

定义接⼝⽂档规范（如接⼝路径、参数、返回值、数据结构等）。

a.接⼝路径：/开头，⽆需设置⽹址端⼝号等

b.基础信息

c.请求参数

常⽤参数类型

▪form-data：即
Content-Type
为multipart/form-data。

▪x-www-form-urlencoded：即
Content-Type
为appliation/x-www-form-

urlenoded。

▪json：即
Content-Type
为
appliation/json。

▪binary：发送⽂件类数据时使⽤。

d.参数变量使⽤

所有参数都可以使⽤变量，使⽤⽅式为双⼤括号包裹变量名，如{{my_variable}}

e.返回响应

2.3接⼝测试运⾏

点击运⾏标签即可测试运⾏

ps:接⼝运⾏参数，只能保存为⽤例，⽽不能保存到接⼝⽂档