# 一.简单介绍
# 1.简介
Apifox (opens new window) 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台，定位 Postman + Swagger + Mock + JMeter。通过一套系统、一份数据，解决多个系统之间的数据同步问题。只要定义好 API 文档，API 调试、API 数据 Mock、API 自动化测试就可以直接使用，无需再次定义；API 文档和 API 开发调试使用同一个工具，API 调试完成后即可保证和 API 文档定义完全一致。高效、及时、准确！🔥🔥🔥
- 使用 Swagger 管理 API 文档
- 使用 Postman 调试 API
- 使用 mockjs 等工具 Mock API 数据
- 使用 JMeter 做 API 自动化测试
Apifox = Postman + Swagger + Mock + JMeter
1
Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化协作平台。
通过一套系统、一份数据，解决多个系统之间的数据同步问题。只要定义好接口文档，接口调试、数据 Mock、接口测试就可以直接使用，无需再次定义；接口文档和接口开发调试使用同一个工具，接口调试完成后即可保证和接口文档定义完全一致。高效、及时、准确！
# 2.功能
- 接口设计：Apifox 接口文档遵循 OpenApi (opens new window) 3.0 (原 Swagger)、JSON Schema (opens new window) 规范的同时，提供了非常好用的
可视化文档管理功能，零学习成本，非常高效。并且支持在线分享接口文档。 - 数据模型：可复用的数据结构，定义接口
返回数据结构及请求参数数据结构（仅 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 (opens new window) 规则引擎，非常方便 mock 出各种数据，并且可以在定义数据结构的同时写好 mock 规则。支持添加“期望”，根据请求参数返回不同 mock 数据。最重要的是 Apifox
零配置即可 Mock 出非常人性化的数据，具体在本文后面介绍。 - 数据库操作：支持读取数据库数据，作为接口请求参数使用。支持读取数据库数据，用来校验(断言)接口请求是否成功。
- 接口自动化测试：提供接口集合测试，可以通过选择接口（或接口用例）快速创建测试集。目前接口自动化测试更多功能还在开发中，敬请期待！目标是： JMeter 有的功能基本都会有，并且要更好用。
- 快捷请求：类似 Postman 的接口调试方式，主要用途为临时调试一些
无需文档化的接口，无需提前定义接口即可快速调试。 - 代码生成：根据接口及数据数据模型定义，系统自动生成
接口请求代码、前端业务代码及后端业务代码。 - 团队协作：Apifox 天生就是为团队协作而生的，接口云端实时同步更新，成熟的
团队/项目/成员权限管理，满足各类企业的需求。
# 二.软件设置
# 1.项目设置
# 2.设置超时时间
在通用中设置,0 为不设置超时时间,目前设置了也不起作用,应该是个 bug
# 3.变量
用于区分不同的环境
# 三.简单使用
# 1.实际请求
通过实际请求可以看到具体的请求信息
# 2.客户端请求
不同语言的请求方式
# 3.http 请求
# 4.curl接口保存
导入curl:
保存为接口:
# 四.idea 插件
# 1.说明
Apifox IDEA 插件（Apifox Helper） 主要用于 IDEA 项目快速生成 API 文档，并同步到 Apifox，代码零入侵。
- 基于 javadoc（Java）、KDoc（Kotlin）、ScalaDoc（Scala） 解析 API 文档。
- 支持 Swagger 注解
- 导出 API 文档到 Apifox
- 导出 Markdown 格式 API 文档
- 在 IDEA 中直接发起 API 请求
# 2.配置
- 项目 id
- 访问令牌
# 3.配置
#添加子目录
mall-admin:2051427,管理后台
mall-search:2051427,搜索
mall-admin:2051427,商城/后台管理
mall-search:2051427,商城/商城搜索
1
2
3
4
5
6
7
2
3
4
5
6
7
同步接口:
在模块目录上的右键菜单中选择
Upload to Apifox在代码编辑区域的右键菜单中选择
Upload to Apifox同步单个接口
ApifoxHelper选择 Export api
# 4.同步
# 5.验证
新增接口后,点击刷新
# 五.压力测试
# 1.压测
- 多线程
- 循环次数
# 2.新建分组
# 3.新建流程
# 4.查看报告
# 六.其他功能
# 1.常用公共 API
# 2.响应结果同步到文档
