Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台,定位 Postman + Swagger + Mock + JMeter
。通过一套系统、一份数据,解决多个系统之间的数据同步问题。只要定义好 API 文档,API 调试、API 数据 Mock、API 自动化测试就可以直接使用,无需再次定义;API 文档和 API 开发调试使用同一个工具,API 调试完成后即可保证和 API 文档定义完全一致。高效、及时、准确!
- 1 -
Apifox安装及设置
下载安装
官网:https://www.apifox.cn/
选择好操作系统下载即可,也可直接使用web版。
登录
注册账号,也可支持微信登录
- 2 -
Apifox功能
接口设计
Apifox 接口文档遵循 OpenApi 3.0 (原 Swagger)、JSON Schema 规范的同时,提供了非常好用的可视化文档管理功能,零学习成本,非常高效。并且支持在线分享接口文档。
数据模型
可复用的数据结构,定义接口返回数据结构及请求参数数据结构(仅 JSON 和 XML 模式)时可直接引用。支持模型直接嵌套引用,直接 JSON/XML 智能导入,支持 oneOf、allOf 等高级组合模式。
接口调试
Postman 有的功能,比如环境变量、前置/后置脚本、Cookie/Session 全局共享 等功能,Apifox 都有,并且比 Postman 更高效好用。接口运行完之后点击保存为用例按钮,即可生成接口用例,后续可直接运行接口用例,无需再输入参数,非常方便。自定义脚本 100% 兼容 Postman 语法,并且支持运行 javascript、java、python、php、js、BeanShell、go、shell、ruby、lua 等各种语言代码。
接口用例
通常一个接口会有多种情况用例,比如参数正确用例、参数错误用例、数据为空用例、不同数据状态用例等等。运行接口用例时会自动校验数据正确性,用接口用例来调试接口非常高效。
接口数据 Mock
内置 Mock.js 规则引擎,非常方便 mock 出各种数据,并且可以在定义数据结构的同时写好 mock 规则。支持添加“期望”,根据请求参数返回不同 mock 数据。最重要的是 Apifox 零配置 即可 Mock 出非常人性化的数据,具体在本文后面介绍。
数据库操作
支持读取数据库数据,作为接口请求参数使用。支持读取数据库数据,用来校验(断言)接口请求是否成功。
接口自动化测试
提供接口集合测试,可以通过选择接口(或接口用例)快速创建测试集。目前接口自动化测试更多功能还在开发中,敬请期待!目标是:JMeter 有的功能基本都会有,并且要更好用。
快捷调试
类似 Postman 的接口调试方式,主要用途为临时调试一些无需文档化的接口,无需提前定义接口即可快速调试。
代码生成
根据接口及数据数据模型定义,系统自动生成接口请求代码、前端业务代码及后端业务代码。
团队协作
Apifox 天生就是为团队协作而生的,接口云端实时同步更新,成熟的团队/项目/成员权限管理,满足各类企业的需求。
- 3 -
界面功能介绍
Apifox的整体界面风格跟postman比较类似。
项目团队
打开界面后首先创建团队,创建好团队后,就可以开始新建项目。
发送1个接口请求
(1)新建接口
打开项目之后,点击左侧搜索框旁边的 + 号按钮即可新建接口。
(2)前置/后置操作
前置操作使用场景:
登录接口获取用户名、密码
修改请求的 header 和 query 参数
特殊场景一个接口完成后需要等待一段时间后再去执行下一个接口
后置操作使用场景:
断言接口请求是否正确
提取上一个接口的参数作为下一个接口的变量值
测试完成删除数据库中测试数据
- 4 -
Mock功能
智能Mock功能
(1)选择【本地Mock】环境,添加接口
(2)添加响应数据。在返回响应位置,点击根节点的最右边对的【添加子节点】。就可以添加返回数据了。然后继续添加正在编辑节点的【添加相邻节点】
(3)添加完成后,点击【保存】,再点击【运行】按钮。
- 5 -
自动生成代码
Apifox 可以根据接口模型的定义,自动生成多种语言(Java、Go、Kotlin、Dart、C++、C#、Rust 等)的业务代码。目前 Apifox 支持 130 种语言及框架的代码自动生成。
你可以通过自定义代码模板来生成符合自己团队的架构规范的代码,满足各种个性化的需求。
总体使用下来,Apifox的功能很丰富,是一款优秀的国产软件,关键是免费使用,官方后期也会支持接口性能测试功能(类似JMeter);以及可以自己开发插件等。