Apifox 使用

Apifox介绍

• Apifox官网地址：https://www.apifox.cn/
  跳转到 Apifox

• Apifox功能介绍

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

• Apifox使用场景

Apifox 是接口管理、开发、测试全流程集成工具，使用受众为整个研发技术团队，主要使用者为前端开发、后端开发和测试人员。

• Apifox使用文档
  Apifox 使用文档
  Apifox使用文档地址：https://www.apifox.cn/help/app/introduce/

Apifox 功能

1. 接口设计：Apifox 接口文档提供了非常好用的可视化文档管理功能，非常高效。并且支持在线分享接口文档。
2. 数据模型：可复用的数据结构，定义接口返回数据结构及请求参数数据结构（仅 JSON 和 XML 模式）时可直接引用。
3. 接口调试：Postman 有的功能，比如环境变量、前置/后置脚本、Cookie/Session 全局共享 等功能，Apifox 都有，并且比 Postman 更高效好用。接口运行完之后点击保存为用例按钮，即可生成接口用例，后续可直接运行接口用例，无需再输入参数，非常方便。
4. 接口用例：通常一个接口会有多种情况用例，比如参数正确用例、参数错误用例、数据为空用例、不同数据状态用例等等。运行接口用例时会自动校验数据正确性，用接口用例来调试接口非常高效。
5. 接口数据 Mock：可以在定义数据结构的同时写好 mock 规则。支持添加“期望”，根据请求参数返回不同 mock 数据。
6. 数据库操作：支持读取数据库数据，作为接口请求参数使用。支持读取数据库数据，用来校验(断言)接口请求是否成功。
7. 接口自动化测试：提供接口集合测试，可以通过选择接口（或接口用例）快速创建测试集。
8. 快捷请求：类似 Postman 的接口调试方式，主要用途为临时调试一些无需文档化的接口，无需提前定义接口即可快速调试。
9. 代码生成：根据接口及数据数据模型定义，系统自动生成接口请求代码、前端业务代码及后端业务代码。
10. 团队协作：Apifox 天生就是为团队协作而生的，接口云端实时同步更新，成熟的团队/项目/成员权限管理，满足各类企业的需求。

接口管理最佳实践步骤

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

Apifox 软件使用介绍

Apifox 下载并安装

下载网址，可以点这里 Apifox

支持 Windows（64 位）、Windows（32 位）、MacOS（Intel 芯片）、MacOS（M1 芯片）、Linux（.Applmage）、Linux（.tar.gz）。

注册账户

推荐使用微信扫码登录，如果没有账户会新建账户，只需扫码就可完成，以后登录只需要微信扫码即可。
同时也支持邮箱注册

创建团队

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

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

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

创建项目

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

进入项目

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

接口概览页

接口设计界面

接口运行界面

总结

各个模块的详细使用说明，请看Apifox使用文档 Apifox使用文档
或者进入帮助中心