Apifox 使用文档

更新日志

# 更新日志

升级方法：Apifox (opens new window) 软件内“检查更新”，或从官网 (opens new window)手动下载。

Alpha 版说明

Alpha 版为新功能尝鲜版，需要加官方微信群、QQ 群或钉钉群，才能参与 Alpha 版内测。

加群方式：apifox.cn/help/app/contact-us (opens new window)

  1. Apifox 新功能都会先在 Alpha 版上线，等稳定后才会合到正式版。
  2. Alpha 版可能会有一些 bug，如遇到问题及时在群里反馈，我们会第一时间解决。
  3. Alpha 版和正式版数据是互通的。
  4. 已经是 Alpha 版的，直接点击软件内更新。

# 1.4.13-alpha.1

2021-11-12

  • 🔥 【新功能】动态参数全新升级
    • 参数值升级为动态参数，支持：变量、常量、动态变量、自定义表达式。
    • 键入变量编辑框时，下拉菜单显示符合的全局变量和环境变量，并显示变量值。
    • 鼠标悬停 动态参数上时，直观显示变量/表达式结果值。
    • 动态变量支持 Mock.js 语法，发起请求时动态使用 mock 值
    • 自定义表达式支持 Nunjucks 模板语法，按条件生成不同参数值
    • 动态参数支持多种常用函数(如 Encodeurl、MD5 加密等)，可多层叠加，直接预览最终结果
  • ⚡️ 【优化】高级 Mock 功能升级
    • 返回数据支持 Mock.js、 Nunjucks 模板语法
    • 支持自定义返回的 Header 值、HTTP 状态码、响应延迟时间

# 1.4.10

2021-10-29

  • 🔥 【新功能】上线 API Hub功能。
    • 通过API Hub查找/发现他人公开的 API 项目。
    • 可将项目发布到API Hub（设置为公开项目即可），允许任何人通过API Hub访问、克隆该项目。
  • 🔥 【新功能】增加文档功能，支持 Markdown 语法，编辑时可同步预览。
  • 🔥 【新功能】接口列表支持根据状态、标签筛选。
  • 🔥 【新功能】增加项目收藏功能。
  • 🔥 【新功能】增加最近访问项目功能。
  • 🔥 【新功能】环境允许设置为私人(仅本人可见)/公共。
  • 🔥 【新功能】前、后置操作里的每一项支持设置启用、停用，方便调试。
  • 🔥 【新功能】GET 请求支持 Body 参数。
  • 🔥 【新功能】新增项目列表拖拽排序功能。
  • 🔥 【新功能】新增用户主动退出团队功能。
  • 🔥 【新功能】新增用户头像功能。
  • 🔥 【新功能】新增项目图标功能。
  • 🔥 【新功能】新增展开/收起全部接口分组功能。
  • 🔥 【新功能】自动导入数据支持Apifox 格式。
  • 🔥 【新功能】接口信息新增 OperationId ，导出 Swagger 文档时包含该字段。
  • 🔥 【新功能】接口信息支持设置原始文档地址。
  • 🔥 【新功能】导如/导出 OpenAPI 格式，增加自定义扩展：
    • 增加扩展 x-apifox-folder：表示接口分组名，如果属性值中含有字符 / 则自动分为多级目录。
    • 导入 OpenAPI 格式时，接口分组优先读取 x-apifox-folder 属性，其次读取tag name 属性。
  • 🔥 【新功能】支持点击鼠标中键关闭 tab 页。
  • ⚡️ 【优化】合并展示 HTTP 和 SOCKET 接口。
  • ⚡️ 【优化】允许将接口放在根目录。
  • ⚡️ 【优化】接口调试/接口用例更方便的开启/关闭自动校验“返回 Response ”功能。
  • ⚡️ 【优化】标签输入优化：下拉框自动提示本项目所有标签。
  • ⚡️ 【优化】接口运行结果中有链接时，支持点击链接在浏览器中打开。
  • ⚡️ 【优化】断言信息限制展示高度，内容过长时可滚动展示。
  • ⚡️ 【优化】解散团队时进行二次确认，防止误操作。
  • ⚡️ 【优化】导入 JMeter 文件时，有接口未选中 method 时仍支持导入。
  • ⚡️ 【优化】若接口管理处用例发生变更，无需重新进测试管理-用例页，直接运行也能按更新后的数据发起请求。
  • ⚡️ 【优化】Windows 系统测试用例/套件，下拉菜单难以选中的问题。
  • ⚡️ 【优化】Windows 系统删除操作时确认弹窗样式问题。
  • ⚡️ 【优化】保存接口时自动识别并去除路径前后的空格。
  • ⚡️ 【优化】样式优化，所有提示图标组件透明度设置为 25% 。
  • ⚡️ 【优化】支持 Linux 系统下设置禁用 GPU 加速。
  • 🐞 解决后置操作添加2个 SQLServer 数据库操作步骤时，第二个 SQL 会运行失败的问题。
  • 🐞 解决 Oracle 数据库运行 Update 语句没有生效的问题
  • 🐞 解决在接口管理页打开生成代码&选中"接口请求代码"，再切到"数据模型"打开生成代码，会显示空白的问题。
  • 🐞 解决导入swagger文件后运行，int类型的请求字段参数值为空的问题。
  • 🐞 解决测试用例/套件分类修改，选中根目录时修改失效的问题。
  • 🐞 解决非完整链接的接口，选择了非mock的环境时，生成代码按钮失效的问题。
  • 🐞 解决只读用户可以修改接口/接口分类/数据模型/数据模型分类的问题。
  • 🐞 解决多服务下，接口生成的cURL命令地址为默认服务而非选中服务的问题。

# 1.4.7

2021-09-10

  • 🔥 【新功能】支持一个环境设置多个前置URL（解决一个项目内有不同接口使用不同前置URL问题）。
  • 🔥 【新功能】支持全局设置（在项目概览里设置）前置操作、后置操作，设置后项目里的所有接口运行时都会生效。
  • 🔥 【新功能】支持分组里设置前置操作、后置操作、前置URL，设置后分组里的所有接口运行时都会生效。
  • 🔥 【新功能】增加克隆项目功能（可克隆项目到当前团队或其他团队）。
  • 🔥 【新功能】支持更多接口状态（设计中、待确定、开发中、联调中、测试中、已测完、已发布、已废弃、有异常），可自自行设置是否启用各种接口状态。
  • ⚡️ 【优化】凸显快捷调试入口，方便新人认识使用该功能。
  • ⚡️ 【优化】接口管理增加根目录项目概览，方便快速打开项目概览。
  • ⚡️ 【优化】测试用例、测试套件运行时优化（解决循序次数过大时会出现卡住的问题）。
  • ⚡️ 【优化】分类改名为分组。
  • ⚡️ 【优化】JSON/XML 智能识别输入框展示优化：将JSON/XML拆分成JSON、XML两个tab。
  • ⚡️ 【优化】允许普通成员（项目权限）管理公共脚本。
  • ⚡️ 【优化】环境Mock服务固定写死名称、前置URL，禁止删除，防止误操作。
  • 🐞 解决部分场景下导入 RAP 接口文档，Body参数没有导入进来的问题。
  • 🐞 解决部分场景下导入 Swagger2 格式的时候，Request Body 未识别为json 的问题。
  • 🐞 解决部分情况导入curl query 参数未被正确识别的问题。
  • 🐞 解决部分情况使用快捷键Ctrl+Enter发起请求，没有带上接口参数值、没有运行前后置脚本、有时提示没有选中环境的问题。
  • 🐞 解决根节点设置允许 NULL时，mock 数据异常的问题。

# 1.4.5

2021-08-24

  • 🔥【新功能】环境里的额外参数升级为全局参数。
    • 全局参数可设置是否所有接口默认启用；每个接口可单独设置是否启用。
    • 全局参数可设置是默认值；每个接口运行时可单独设置参数值。
  • 🔥【新功能】测试数据功能升级。
    • 测试数据支持云端同步，成员之间共享测试数据。
    • 支持在线编辑测试数据。
    • 同一个测试用例支持不同环境使用不同测试数据。
  • 🔥 【新功能】支持微信登录，已注册的账号支持绑定微信。
  • 🔥 【新功能】自定义脚本内置库支持 RSA 加密解密（使用 npm 库：jsrsasign (opens new window)）。
  • 🔥 【新功能】自定义脚本支持调用未内置的 npm JS 库（使用pm.liveRequire方法动态加载），查看文档。
  • ⚡️ 【优化】接口复制功能优化。
    • 增加复制整个目录功能。
    • 复制接口同时复制接口下的用例。
  • ⚡️ 【优化】Apifox CLI 支持数据库操作。
  • ⚡️ 【优化】高级 Mock 期望条件支持 json 格式的 Body 参数（使用 JSON Path 匹配）。
  • ⚡️ 【优化】接口 Body 参数内容长度限制从50KB增加到10MB。
  • ⚡️ 【优化】数据模型分类下增加添加子分类选项，新建分类的时候允许选择父级分类。
  • ⚡️ 【优化】运行接口，用户未选择环境时，提示语显示到"环境选择框"的下方。
  • 🐞 解决接口和环境额外参数里都设置了Content-Type时导致请求时产生多个Content-Type的问题。
  • 🐞 解决接口路径太长时，运行界面把后面 2 个按钮撑出界面的问题。
  • 🐞 解决文件上传，保存用例后再次打开，没有显示对应文件的问题。

# 1.4.4

2021-07-25

  • 🐞 解决 1.4.3 版部分情况下 Mock 生成的数据有异常的问题。

# 1.4.3

2021-07-22

  • 🔥【新功能】环境管理功能升级，支持环境复制和排序。
  • 🔥【持续集成】Apifox CLI 支持使用URL方式运行“测试用例”和“测试套件”，无需导出数据，且实时更新数据。
  • 🔥【接口管理】解决导出 Apifox 文件再导入时部分数据未导入的问题。
  • 🐞 解决“编辑接口文档时，分类只能选最末尾的分类，不能选倒数第二级的分类”的问题。
  • 🐞 解决自动导入时设置“不覆盖”时无效的问题。
  • 🐞 解决数据结构里的 mock 下拉框，定位到选项后，按回车键不能自动填充的问题。
  • 🐞 解决数据结构编辑器修改字段类型后，中文名、mock内容被清空的问题。
  • 🐞 解决接口文档设置响应字段允许 null 之后，该字段的 mock 规则不生效的问题。
  • 🐞 解决数据结构 array 类型在展示的时候不显示字段名的问题。
  • 🐞 解决编辑接口字段时，光标未移出编辑框，直接 ctrl+s 保存失败的问题。

# 1.4.0

2021-07-12

  • 🔥【新功能】支持多窗口打开多个项目。
  • 🔥【测试用例】导入【接口用例】时可选择绑定模式，绑定后修改【接口用例】后会实时同步更新到【测试用例】里。
  • 🔥【提取变量】提取来源增加支持“Response Header”、“Response Cookie”。
  • 🔥【断言】断言对象增加支持“Response Header”、“Response Cookie” 、“环境变量”、“全局变量”、“临时变量”。
  • ⚡️【样式】Windows/Linux 版本采用和mac一样的无边框/无状态栏设计。
  • ⚡️【测试管理】测试用例/测试套件增加复制功能。
  • ⚡️【其他】双击顶部栏可以最大化。
  • ⚡️【主题】主题色设置功能放到【设置】里。
  • ⚡️【其他】新建项目时，普通成员的项目权限默认设置为【禁止访问】。
  • ⚡️【接口管理】公共 Response升级为全局 Response。
  • ⚡️【接口管理】创建内容时，如果没有任何分类，则增加一个选项“默认分类”。
  • ⚡️【Mock】高级 Mock 新建期望【返回数据】处加上“自动生成”功能。
  • ⚡️【接口管理】接口管理里的Tab窗口增加“关闭其他所有 Tab”项。
  • ⚡️【Cookie】Cookie 管理样式升级。
  • ⚡️【其他】其他优化界面细节。
  • 🐞 解决在线分享功能设置接口文档有效时间后，又将有效日期置空，保存后无效的问题。
  • 🐞 解决接口描述里有$0等特殊字符时，导出的html格式的文件打开会报错。
  • 🐞 解决导入NEI格式接口数据，请求/响应里的object类型数据没有子节点
  • 🐞 解决在线分享的接口无法搜索接口名问题。

# 1.3.11

2021-06-08

  • ⚡️ 测试报告增加导出功能。
  • ⚡️ 允许只读成员修改环境变量和全局变量的本地值。
  • ⚡️ 断言不通过时展示详细原因（包括期望值和实际值）。
  • ⚡️ 优化界面细节。
  • 🐞 解决断言功能用等于方式断言数字类型值时不准确的问题。
  • 🐞 解决导入 Eolinker 格式数据，数据结构直接引用另一个数据结构时，无法解析的问题。

# 1.3.10

2021-06-04

  • ⚡️ 测试报表（测试套件）详情增加筛选项。
  • 🐞 解决断言功能用等于方式断言数字类型值时不准确的问题。

# 1.3.9

2021-06-02

  • ⚡️ 整体样式细节优化。
  • ⚡️ 测试报表（测试用例）详情增加筛选项，可筛选查看所有失败的步骤。
  • ⚡️ 导入 Postman 格式支持导入前置脚本、后置脚本。
  • 🐞 解决亮主题看不到登录界面/注册界面的logo文字的问题。
  • 🐞 解决断言功提取到的值为数字，且使用正则匹配时，断言始终报错的问题。
  • 🐞 其他 bug 修改。

# 1.3.8

2021-05-28

  • ⚡️ 测试报告支持批量删除、支持翻页。
  • ⚡️ 测试用例分类下可直接添加测试用例，测试套件分类下可直接添加测试套件。
  • ⚡️ 提取变量的表达式支持使用变量。
  • ⚡️ 数据模型 icon 展示优化。
  • ⚡️ 支持导入NEI格式数据。
  • 🐞 解决部分场景下 Path 中包含:时，被误识别为 Path 参数问题。
  • 🐞 解决测试套件勾选保存变量变化值无效问题。
  • 🐞 解决GET请求包含body参数时，在接口文档里不展示body参数的问题。

# 1.3.7

2021-05-20

  • ⚡️ 断言里的值支持使用引用变量。

# 1.3.6

2021-05-13

  • ⚡️ 接口树形列表中展示接口状态（开发中、测试中、已上线、已废弃）。
  • ⚡️ 其他细节优化。

# 1.3.5

2021-05-10

  • 🐞 解决Socket接口某些场景下使用报错的问题。

# 1.3.4

2021-05-06

  • 🔥 新增自动导入功能，可设置定时自动导入OpenAPI (Swagger)、apiDoc格式接口数据。
  • ⚡️ 运行接口时允许选择不校验接口返回的状态码和数据结构（返回 Response选择不校验即可）。
  • ⚡️ 优化导入apiDoc 格式数据效果。
  • 🐞 解决首次登录时，会出现打开数据库连接页面空白问题。

# 1.3.3

2021-04-25

  • ⚡️ 新增支持导入 apiDoc 格式数据。

# 1.3.2

2021-04-19

  • 🐞 解决导入 Postman 格式数据时，如数据里有url为null时导入报错的问题。

# 1.3.1

2021-04-17

  • 🐞 解决测试管理里的测试用例和测试套件无法运行含数据库操作的用例。

# 1.3.0

2021-04-16

  • 🔥 前置/后置脚本、断言、提取变量，升级为前置操作/后置操作。
    • 前置操作/后置操作里支持添加“断言、提取变量、数据库操作、自定义脚本、公共脚本”等动作。
    • 前置操作/后置操作支持添加数据库操作，可读写数据库数据，查询结果可在接口请求参数、断言等场景中使用。
    • 前置操作/后置操作未来会支持更多动作类型，将原本需要写代码实现的功能界面化，降低使用难度和提高使用效率。
  • ⚡️ 优化 断言名称支持使用变量。
  • ⚡️ 优化 导入数据支持 ApiPost 数据格式。
  • 🐞 解决控制台看不到通过自定义脚本发送的接口请求信息。

# 1.2.5

2021-04-03

  • ⚡️ 导入数据优化：
    • 导入 Postman、HAR、JMeter 格式允许选择接口路径保留前置 URL。
    • 导入 Swagger 2 数据允许选择接口路径加上 basePath。

# 1.2.4

2021-03-26

  • 🐞 解决部分场景下新建接口点击”保存“按钮卡住的问题。
  • 🐞 解决部分场景下通过url导入swagger数据提示权限限制问题。

# 1.2.2

2021-03-18

  • 🐞 解决部分场景下数据结构 mock 出的数据不符合预期的问题。

# 1.2.1

2021-03-17

  • ⚡️ 新增 设置【网络代理】功能，允许通过代理发送接口请求，默认使用系统代理。
  • ⚡️ 优化 添加断言和提取变量里的JSON Path、XPath使用指引。

# 1.2.0

2021-03-14

  • 🔥 新增【在线分享接口文档】功能。
  • ⚡️ 优化 可视化断言功能支持使用变量。
  • ⚡️ 优化 数据结构展示：1、允许选择复制内容。2、优化引用模型时候的展示（减少层级，更直观）
  • ⚡️ 优化 主页 Tab 增加“关闭全部 Tab”功能。
  • ⚡️ 优化 快捷调试支持上传文件。
  • ⚡️ 优化 其他部分细节。
  • 🐞 解决测试用例里点开接口详情调试时，当前界面无法选择环境、点击管理公共 Response和管理公共脚本没有反应的问题。
  • 🐞 解决部分情况下数据结构 object 类型字段点击添加相邻节点没有反应的问题。
  • 🐞 解决部分情况下导入 Postman 数据报错的问题。

# 1.1.21

2021-02-20

  • 🐞 解决打开部分情况下导入抓包数据无反应问题。

# 1.1.18

2021-02-09

  • 🔥 布局升级

    • 接口管理、测试管理、数据模型、项目设置，统一采用 tab 方式切换，模块之间来回切换时保持已打开内容不被覆盖，方便同时操作不同模块内容。
    • 支持拖拽方式调整侧边栏宽度。
    • 打开控制台时，内容不被遮挡。

  • 🐞 解决打开控制台时侧边栏底部部分内容无法点击问题。

  • 🐞 解决部分情况断言负数出现判断错误问题。

# 1.1.17

2021-01-26

  • 🐞 解决部分场景下运行测试套件时未运行公共脚本问题。

# 1.1.16

2021-01-25

  • 🐞 解决导入ApiPost格式后数据结构字段重复问题。

# 1.1.15

2021-01-18

  • 🐞 解决数据结构allOf、oneOf、anyOf里包含引用模式时，无法正确mock出数据问题。

  • 🐞 解决快捷调试无法自动添加环境变量里的前置URL问题。

  • 🐞 解决测试用例（或测试套件）循环测试的结果里第二轮及后续循环结果都误展示为第一轮循环的结果。

# 1.1.12

2021-01-13

  • ⚡️ 优化 导入 Swagger 数据时，自动导入参数示例值

  • ⚡️ 优化 部分细节。

  • 🐞 解决部分场景运行接口时没有自动校验数据结构问题。

  • 🐞 解决一个测试套件里不同测试用例无法共享环境变量/全局变量的问题。

  • 🐞 解决部分场景调试接口时未显示返回 Cookie和返回 Header问题。

  • 🐞 解决快捷调试返回的 json 数据展示时没有格式化的问题。

  • 🐞 解决接口返回的 json 数据里bigint数据精度丢失问题。

  • 🐞 解决导入 Swagger 格式数据，部分场景Path 参数重复问题。

# 1.1.7

2021-01-11

  • ⚡️ 优化 测试用例添加步骤。
  • ⚡️ 优化 导入数据展示

# 1.1.4

2021-01-06

  • 🐞 解决 查看测试报告都显示旧版数据，不兼容问题。
  • 🐞 解决 测试套件无法导出 Apifox CLI 格式数据问题。

# 1.1.0

2021-01-04

  • 🔥 新增快速 断言和提取变量 功能，无需写脚本就可以设置断言和从运行结果里提取变量了。
  • 🔥 新增 测试用例和测试套件支持上传测试文件（csv 或 json），将测试文件里的数据作为变量值批量循环测试。
  • 🔥 Socket 接口相关功能全面升级。
  • ⚡️ 优化 数据结构支持设置字段的中文名，支持展示 json schema 里字段的 title。
  • ⚡️ 优化 部分细节。
  • 🐞 解决 导入 OpenAPI (Swagger) 数据时，path 参数无法正确解析的问题。
  • 🐞 解决 导入 OpenAPI (Swagger) 数据时，数据结构 allOf、anyOf、oneOf 中包含 $ref 时无法正确解析的问题。

# 1.0.0

2020-12-28

  • 🔥 1.0.0 版正式发布

联系我们