博主首页：求不脱发的博客

精彩摘要：Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台，定位 Postman + Swagger + Mock + JMeter。API 文档和 API 开发调试使用同一个工具，API 调试完成后即可保证和 API 文档定义完全一致。高效、及时、准确！

觉得文章还不错的话欢迎大家点赞➕收藏⭐️➕评论支持博主

目录

Apifox：节省研发团队的每一分钟

1️⃣揭秘Apifox

✨什么是Apifox？

✨为什么要使用Apifox？

✨Apifox的功能或特点？

✨哪里用得到Apifox？

✨谁在用Apifox？

2️⃣Apifox快速上手

✨下载

✨安装

Apifox：节省研发团队的每一分钟

1️⃣揭秘Apifox

✨什么是Apifox？

官方网站：http://www.apifox.cn

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

定位： Apifox = Postman + Swagger + Mock + JMeter。

宗旨：节省研发团队的每一分钟

✨为什么要使用Apifox？

开发团队的痛点：

随着物联网化、微服务化和DevOps化等等新技术转型，各团队的API数量需求呈爆发式增长。整个开发团队的协同中，很多工作都是围绕API进行。然而在现有的工作流程中，很多API 协同工作被分散在很多不通过工具中，包括Postman、Swagger、Mock和JMeter等。对于提示API开发效率，并且保障API质量所面临最大的障碍就是缺乏合适的技术和工具。开发过程中经常遇到的问题前端、后端和测试Team对于API的协同效率低下。

常用解决方案：

存在的问题：

  • 维护不同工具之间数据一致性非常困难、低效。并且这里不仅仅是工作量的问题，更大的问题是多个系统之间数据不一致，导致协作低效、频繁出问题，开发测试人员痛苦不堪。

  • 开发人员在 Swagger 定义好文档后，接口调试的时候还需要去 Postman 再定义一遍。

  • 前端开发 Mock 数据的时候又要去 mockjs 定义一遍，还需要手动设置 Mock 规则。

  • 测试人员需要去 JMeter 再定义一遍。

  • 前端根据 mockjs Mock 出来的数据开发完，后端根据 Swagger 定义的接口文档开发完，各自都试测试通过了，本以为可以马上上线，结果一对接发现各种问题：

    • 开发过程中接口变更了，只修改了 Swagger，但是没有及时同步修改 mockjs。
    • 后端开发的接口数据类型和文档不一致，肉眼难以发现问题。
  • 同样，测试在 JMeter 写好的测试用例，真正运行的时候也会发现各种不一致。
  • 时间久了，各种不一致会越来越严重。

使用Apifox：Postman + Swagger + Mock + JMeter

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

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

✨哪里用得到Apifox？

最佳实践

  1. 前端（或后端）：在 Apifox 上定好接口文档初稿。
  2. 前后端：一起评审、完善接口文档，定好接口用例。
  3. 前端：使用系统根据接口文档自动生成的 Mock 数据进入开发，无需手写 mock 规则。
  4. 后端：使用接口用例 调试开发中接口，只要所有接口用例调试通过，接口就开发完成了。如开发过中接口有变化，调 试的时候就自动更新了文档，零成本的保障了接口维护的及时性。
  5. 后端：每次调试完一个功能就保存为一个接口用例。
  6. 测试人员：直接使用接口用例测试接口。
  7. 所有接口开发完成后，测试人员（也可以是后端）使用集合测试功能进行多接口集成测试，完整测试整个接口调用流 程。
  8. 前后端都开发完，前端从Mock 数据切换到正式数据，联调通常都会非常顺利，因为前后端双方都完全遵守了接口定 义的规范。

✨谁在用Apifox？

2️⃣Apifox快速上手

✨下载

下载网址，可以点这里 Apifox ，支持 Windows（64 位）、Windows（32 位）、MacOS（Intel 芯片）、MacOS（M1 芯片）、Linux（.Applmage）、Linux（.tar.gz）。

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

✨安装

根据安装包的指引即可完成。

✨注册

推荐使用微信扫码登录，如果没有账户会新建账户，只需扫码就可完成，以后登录只需要微信扫码即可。

同时也支持邮箱注册。

✨创建团队

登录成功后，显示为团队页面。我们会为您提供一个示例团队中的示例项目，您可以点击进入，对软件进行一些学习和探索

您也可以新建一个自己的团队，如下图

您也可以让您团队成员邀请您进入已有团队，接受邀请时，可以点击右上角铃铛处操作

关于团队管理可以查看 团队管理

✨创建项目

如下图，可以点击新建项目，建立新的项目

✨进入项目

这里以新建项目为参考讲解，您可以通过《一分钟，了解 Apifox！》了解大致的内容，也可以点击《20 分钟学会 Apifox》观看视频

✨导入数据

详细可以查看 导入数据

✨导出数据

详细可以查看 导出数据

✨接口概览

✨接口设计

详细可以查看 接口设计

✨接口运行

更多各个模块的详细使用说明，请看 帮助中心