【工具推荐】Apifox使用攻略详解

简介: Apifox使用攻略详解

目录

前言

Apifox 介绍

1 . Apifox 的定位

2 . Apifox的功能

Apifox功能

1、接口支持“用例管理”

2、“数据模型”定义、引用

3、调试时“自动校验”数据结构

4、“可视化”设置断言

5、“可视化”设置提取变量

6、支持数据库操作

7、“零配置”Mock 出非常人性化的数据

Apifox使用介绍


前言

作为一个前后端分离模式开发的团队,我们经常会看到这样的场景:前端开发和后端开发在一起热烈的讨论“你这接口参数怎么又变了?”,“接口怎么又不通了?”,“稍等,我调试下”,“你再试试..."。那能不能写好接口文档,大家都按文档来开发?很难,因为写文档、维护文档比较麻烦,而且费时,还会经常出现 API 更新了,但文档还是旧的,各种同步不一致的情况,从而耽搁彼此的时间。

今天给大家推荐一款丧心病狂的API测试工具:Apifox。

Apifox 是接口管理、开发、测试全流程集成工具,定位 Postman + Swagger + Mock + JMeter。点击此处跳转下载

img编辑

体会Apifox 的神奇之处:

Apifox 介绍

1 . Apifox 的定位

Apifox = Postman + Swagger + Mock + JMeter

Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台。

通过一套系统、一份数据,解决多个系统之间的数据同步问题。只要定义好接口文档,接口调试、数据 Mock、接口测试就可以直接使用,无需再次定义;接口文档和接口开发调试使用同一个工具,接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确!

2 . Apifox的功能

img编辑

  • 接口设计: 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 天生就是为团队协作而生的,接口云端实时同步更新,成熟的团队/项目/成员权限管理,满足各类企业的需求。

Apifox 如何做到高效率零配置生成非常人性化的 mock 数据

  1. Apifox 根据接口定义里的数据结构、数据类型,自动生成 mock 规则。
  2. Apifox 内置智能 mock 规则库,根据字段名、字段数据类型,智能优化自动生成的 mock 规则。如:名称包含字符串imagestring类型字段,自动 mock 出一个图片地址 URL;包含字符串timestring类型字段,自动 mock 出一个时间字符串;包含字符串citystring类型字段,自动 mock 出一个城市名。
  3. Apifox 根据内置规则,可自动识别出图片、头像、用户名、手机号、网址、日期、时间、时间戳、邮箱、省份、城市、地址、IP 等字段,从而 Mock 出非常人性化的数据。
  4. 除了内置 mock 规则,用户还可以自定义规则库,满足各种个性化需求。支持使用 正则表达式通配符 来匹配字段名自定义 mock 规则。

Apifox功能

如果你认为 Apifox 只做了数据打通,来提升研发团队的效率,那就错了。Apifox 还做了非常多的创新,来提升开发人员的效率。

1、接口支持“用例管理”

通常一个接口会有多种情况用例,比如 正确用例 参数错误用例 数据为空用例 不同数据状态用例。定义接口的时候定义好这些不同状态的用例,接口调试的时候直接运行,非常高效。

2、“数据模型”定义、引用

可以独立定义数据模型,接口定义时可以直接引用数据模型,数据模型之间也可以相互引用。同样的数据结构,只需要定义一次即可多处使用;修改的时候只需要修改一处,多处实时更新,避免不一致。

3、调试时“自动校验”数据结构

使用 Apifox 调试接口的时候,系统会根据接口文档里的定义,自动校验返回的数据结构是否正确,无需通过肉眼识别,也无需手动写断言脚本检测,非常高效!

img

编辑

4、“可视化”设置断言

设置断言:

img

编辑

运行后,查看断言结果:

img

编辑

5、“可视化”设置提取变量

img

编辑

6、支持数据库操作

img

编辑

7、“零配置”Mock 出非常人性化的数据

先放一张图对比下 Apifox 和其他同类工具 零配置 mock 出来的数据效果:

img

编辑

Apifox使用介绍

最佳实践
1.前端(或后端):在 Apifox 上定好接口文档初稿。

2.前后端:一起评审、完善接口文档,定好接口用例。

3.前端:使用系统根据接口文档自动生成的 Mock 数据进入开发,无需手写 mock 规则。

4.后端:使用接口用例 调试开发中接口,只要所有接口用例调试通过,接口就开发完成了。如开发过中接口有变化,调试的时候就自动更新了文档,零成本的保障了接口维护的及时性。

5.后端:每次调试完一个功能就保存为一个接口用例。

6.测试人员:直接使用接口用例测试接口。

7.所有接口开发完成后,测试人员(也可以是后端)使用集合测试功能进行多接口集成测试,完整测试整个接口调用流程。

8.前后端 都开发完,前端从Mock 数据切换到正式数据,联调通常都会非常顺利,因为前后端双方都完全遵守了接口定义的规范。

Apifox 支持 Windows(64 位)、Windows(32 位)、MacOS(Intel 芯片)、MacOS(M1 芯片)、Linux(.Applmage)、Linux(.tar.gz)。

你也可以使用 Web 端版本使用(如果需要导入文档,建议使用客户端

本文只是简单介绍了 Apifox客户端 的基本用法,但是 Apifox 还有很多实用的功能,这里就不再一一展示了,有需要的可以去*Apifox官网*下载体验

相关文章
|
3月前
阿萨学工具:Apifox 用Mock.js写高级Mock的期望
阿萨学工具:Apifox 用Mock.js写高级Mock的期望
|
3月前
|
测试技术 API
阿萨学工具:初识Apifox
阿萨学工具:初识Apifox
|
3月前
|
存储 JSON 测试技术
阿萨学工具: 你会用Apifox写断言吗?
阿萨学工具: 你会用Apifox写断言吗?
|
数据可视化 JavaScript 前端开发
API工具--Apifox和Postman对比(区别)
Postman和Apifox有什么区别?他们之间分别有什么优势,感兴趣的同学可以继续往下看。 不吹不黑,只列功能,纯客观比对。
API工具--Apifox和Postman对比(区别)
|
3月前
|
测试技术 API
阿萨学工具:用Apifox 发送接口请求
阿萨学工具:用Apifox 发送接口请求
|
3月前
|
前端开发
阿萨学工具:Apifox的高级Mock 功能
阿萨学工具:Apifox的高级Mock 功能
|
3月前
阿萨学工具: Apifox 的自定义智能Mock功能
阿萨学工具: Apifox 的自定义智能Mock功能
阿萨学工具:Apifox 用Mock.js写高级Mock的期望
大家好,我是阿萨。今天周一,又是元气满满地一天。今天继续学习Apifox工具。继上周学完阿萨学工具:Apifox的高级Mock 功能。今天我们学习下如何使用Apifox的Mock.js 和nunjucks写高级Mock里的返回值。
249 0
阿萨学工具:Apifox 用Mock.js写高级Mock的期望
|
前端开发
阿萨学工具:Apifox的高级Mock 功能
大家好,我是阿萨。截止目前。我们已经学习了Apifox的mock 功能里的智能Mock内置规则,自定义智能Mock规则,返回字段高级设置里的长度,范围,枚举等Mock功能。
218 0
阿萨学工具:Apifox的高级Mock 功能
阿萨学工具: Apifox 的自定义智能Mock功能
大家好,我是阿萨。上一篇我们学习了智能Mock 功能。但是现实生活中 我们的响应,可能是产品自定义的。
244 0
阿萨学工具: Apifox 的自定义智能Mock功能