Apifox 帮助文档
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. 帮助文档
  • 帮助中心
  • 更新日志
  • 入门
    • 产品介绍
    • 联系我们
    • 私有化部署
  • 开始使用
    • 下载 Apifox
    • 注册与登录
    • 页面布局
    • 基本概念
    • 快速上手
      • 概述
      • 新建接口
      • 发送接口请求
      • 快捷请求
      • 添加断言
      • 新建测试场景
      • 分享 API 文档
      • 了解更多
    • 基础知识
      • 接口基本信息
        • 请求 URL 与方法
        • 请求参数与请求体
        • 请求头
        • 请求参数编码解码
        • HTTP/2
      • 认证与授权
        • 概述
        • 支持的授权类型
        • Digest Auth
        • OAuth 1.0
        • OAuth 2.0
        • Hawk Authentication
        • Kerberos
        • NTLM
        • Akamai EdgeGrid
        • CA 和客户端证书
      • 响应与 Cookie
        • 概述
        • API 响应
        • 创建和发送 Cookie
        • 实际请求
        • 提取响应示例
      • 请求代理
        • 网页端中的请求代理
        • 分享文档中的请求代理
        • 客户端中的请求代理
      • API Hub
        • API Hub
    • 导入导出数据
      • 概述
      • 手动导入
      • 定时导入
      • 导入设置
      • 导出数据
      • 其它方式导入
        • 导入 OpenAPI/Swagger
        • 导入 Postman
        • 导入 Apipost
        • 导入 Eolink
        • 导入 cURL
        • 导入 Markdown
        • 导入 Insomnia
        • 导入 apiDoc
        • 导入 .har 文件
        • 导入 knife4j
        • 导入 NEI
        • 导入小幺鸡(docway)
        • 导入 Apizza
        • 导入 WSDL
  • 设计 API
    • 概述
    • 新建 API 项目
    • 接口基础知识
    • 请求体多示例配置
    • 响应组件
    • 常用字段
    • 全局参数
    • 历史记录
    • 批量管理
    • 数据模型
      • 概述
      • 新建数据模型
      • 构建数据模型
      • 通过 JSON 等生成
      • 高级数据类型
    • 鉴权组件
      • 概述
      • 创建鉴权组件
      • 使用鉴权组件
      • 在线文档中的鉴权组件
    • 高级功能
      • 接口字段
      • 接口状态
      • 关联测试场景
      • 参数列表外观
      • 接口唯一标识
  • 开发和调试 API
    • 概述
    • 生成请求
    • 发送请求
    • 请求历史
    • 接口用例
    • 动态值
    • 校验响应
    • 文档模式/调试模式
    • 生成代码
    • 环境和变量
      • 概述
      • 全局/环境/临时变量
      • 环境与服务
      • Vault Secrets(密钥库)
        • 功能简介
    • 前后置操作&脚本
      • 概述
      • 断言
      • 提取变量
      • 等待时间
      • 数据库操作
        • 概述
        • MySQL
        • MongoDB
        • Redis
        • Oracle
      • 使用脚本
        • 概述
        • 前置脚本
        • 后置脚本
        • 公共脚本
        • pm 脚本 API
        • 使用 JS 类库
        • 响应数据可视化
        • 调用外部程序
      • 脚本示例
        • 断言示例
        • 脚本使用变量
        • 脚本读取/修改接口请求信息
      • 常见问题
        • 如何获取动态参数的真实值并加密?
        • 脚本运行后,提取的数字(bigint)精度丢失应该如何处理?
    • API 调试
      • GraphQL 调试
      • WebSocket 调试
      • Socket.IO 调试
      • SSE 调试
      • SOAP/WebService
      • gRPC 调试
      • 使用请求代理调试
      • Dubbo 调试
        • 新建 Dubbo 接口
        • 调试 Dubbo 接口
        • Dubbo 接口文档
      • TCP(Socket)
        • Socket 接口功能简介
        • 报文数据处理器
  • Mock 数据
    • 概述
    • 智能 Mock
    • 自定义 Mock
    • Mock 优先级
    • Mock 脚本
    • 云端 Mock
    • 自托管 Runner Mock
  • 自动化测试
    • 概述
    • 编排测试场景
      • 新建测试场景
      • 测试步骤间传递数据
      • 测试流程控制条件
      • 从接口/用例同步数据
      • 跨项目导入接口/用例
      • 导出测试场景数据
    • 运行测试场景
      • 运行测试场景
      • 批量运行测试场景
      • 数据驱动测试
      • 定时任务
      • 管理其它项目接口的运行环境
    • 测试报告
      • 测试报告
    • API 测试
      • 集成测试
      • 性能测试
      • 端到端测试
      • 回归测试
    • Apifox CLI
      • 概述
      • 安装和运行 CLI
      • CLI 命令选项
    • CI/CD
      • 概述
      • 与 Jenkins 集成
      • 与 Gitlab 集成
      • 与 Github Actions 集成
      • 与其它更多 CI/CD 平台集成
      • Git 提交自动触发测试
  • 发布 API 文档
    • 概述
    • 快捷分享
    • 查看 API 文档
    • 发布文档站
    • 页面布局设置
    • 自定义域名
    • AI 相关特性
    • SEO 设置
    • 高级设置
      • 文档站搜索设置
      • 跨域代理
      • 文档站接入 Google Analytics
      • 文档左侧目录设置
      • 文档可见性设置
      • 在线 URL 链接规范
    • API 版本
      • 创建 API 版本
      • 发布 API 版本
      • 快捷分享 API 版本
      • 功能简介
  • 迭代分支
    • 功能简介
    • 新建迭代分支
    • 在迭代分支中改动 API
    • 在迭代分支中测试 API
    • 合并迭代分支
    • 管理迭代分支
  • 管理中心
    • 入驻清单
      • 了解基本概念
      • 团队入驻
    • 管理团队
      • 成员角色与权限设置
      • 团队基本操作
      • 团队成员管理
      • 团队资源
        • 通用 Runner
        • 请求代理 Agent
        • 团队变量
      • 实时协作
        • 团队协作
    • 管理项目
      • 项目基本操作
      • 项目成员管理
      • 通知设置
        • 功能简介
        • 通知对象
        • 通知事件
      • 项目资源
        • 数据库连接
    • 管理组织
      • 单点登录(SSO)
        • 功能简介
        • 为组织配置单点登录
        • 管理用户账号
        • 将组映射到团队
        • Microsoft Entra ID
      • SCIM 用户管理
        • 功能简介
        • Microsoft Entra ID
      • 组织资源
        • 自托管 Runner
  • IDEA 插件
    • 快速上手
    • 生成接口文档
    • 生成数据模型
    • 配置
      • 全局配置
      • 项目内配置
      • 可配置规则
      • 脚本工具
      • Groovy 本地扩展
    • 进阶配置
      • 注释规范说明
      • 框架支持
    • 常见问题
      • 常见问题
  • 浏览器扩展
    • Chrome
    • Microsoft Edge
  • Apifox AI 功能
    • 总览
    • 启用 AI 功能
    • 修改数据模型
    • 常见问题
  • Apifox MCP Server
    • 概述
    • 通过 MCP 使用公开发布的 API 文档
    • 通过 MCP 使用 Apifox 项目内的 API 文档
    • 通过 MCP 使用 OpenAPI/Swagger文档
  • 最佳实践
    • 概述
    • 接口之间如何传递数据
    • 登录态(Auth)如何处理
    • 接口签名如何处理
    • 如何加密/解密接口数据
    • Jenkins 定时触发任务
    • 如何计算 AI 问答成本
    • 与其他成员共用数据库连接配置
    • 通过 CLI 运行包含云端数据库连接配置的测试场景
    • 通过 Runner 运行包含云端数据库连接配置的测试场景
    • Apifox 测试步骤之间怎么传递数据?
  • 账号&应用设置
    • 账号设置
    • API 访问令牌
    • 语言设置
    • 快捷键
    • 网络代理
    • 数据备份与恢复
    • 更新 Apifox
    • 实验性功能
  • 身份验证 & Auth 鉴权指南
    • 什么是 API Key
    • 什么是 Bearer Token
    • 什么是 JWT
    • 什么是 Basic Auth
    • 什么是 Digest Auth
    • 什么是 OAuth 1.0
    • 什么是 OAuth 2.0
      • 什么是 OAuth 2.0
      • 授权码授权类型
      • 授权码授权类型,带有 PKCE
      • 隐式授权类型
      • 密码凭证授权类型
      • 客户端凭证授权类型
  • 服务与隐私协议
    • 服务协议
    • 隐私协议
    • 服务等级协议
  • 参考资料
    • API 设计优先理念
    • JSON Schema 介绍
    • JSONPath 介绍
    • XPath 介绍
    • Apifox Markdown 语法
    • CSV 格式规范
    • 正则表达式
    • 安装 Java 环境
    • Runner 运行环境
    • 常见编程语言对应的数据类型
    • Socket 粘包和分包问题
    • 词汇表
    • 目录链接汇总
    • Apifox Swagger 扩展
      • 概述
      • x-apifox-folder
      • x-apifox-status
      • x-apifox-name
      • x-apifox-maintainer
    • Apifox JSON Schema 扩展
      • 概述
      • x-apifox-mock
      • x-apifox-orders
      • x-apifox-enum
    • 动态值表达式
  • 常见问题
  1. 帮助文档

更新日志

升级方法:在 Apifox 客户端内 “检查更新”,或前往官网手动下载最新版本。
Alpha 版说明
Alpha 版为新功能尝鲜版,需要加官方微信群、QQ 群或钉钉群,才能参与 Alpha 版内测。
加群方式:点击此链接扫码加入。
1.
Apifox 新功能都会先在 Alpha 版上线,等稳定后才会合到正式版。
2.
Alpha 版可能会有一些 bug,如遇到问题及时在群里反馈,我们会第一时间解决。
3.
Alpha 版和正式版数据是互通的。
4.
已经是 Alpha 版的,直接点击软件内更新。
Apifox 已规划或正在开发中的需求,可以查看 Road Map。

2.7.19#

2025-06-27
⚡️【优化】自定义角色权限时,支持配置 Mock 功能相关的权限
⚡️【优化】设置团队成员的项目权限时,支持搜索项目
⚡️【优化】通用接口文档支持分支
⚡️【优化】将响应的 JSON 数据提取为响应示例时,会对 JSON 格式化
⚡️【优化】提升了 App 内获取个人消息列表的速度
🐞 解决开启了实验性功能“使用独立进程执行 API 请求”后,调试 WebSocket、Socket.IO、gRPC Streaming 接口时无法发送消息的问题
🐞 解决地址栏中前置 URL 列表无法滚动的问题
🐞 解决配置在线文档顶部导航栏时的交互问题
🐞 解决部分情况下,子分支的测试场景引用主分支的测试场景时,两边数据不同步的问题
🐞 解决无法导入 RAML 格式数据的问题
🐞 解决导出 Apifox 格式数据时,未包含测试场景的备注信息的问题

2.7.18#

2025-06-20
🔥【新功能】可以通过 AI 修改数据模型的字段描述、中文名、Mock 等信息
AI 修改数据模型的字段信息
🔥【新功能】可以在团队中配置 AI 模型供应商的 API Key 从而启用 Apifox AI 功能
配置 AI 模型供应商的 API Key
🔥【新功能】可以在 Apifox 中复制接口的 OpenAPI/Swagger 数据、MCP Server 配置,以供 Cursor 等 AI 编程工具读取接口文档
在 Apifox 中复制 MCP Server 配置
🔥【新功能】gRPC 项目 支持在调试接口时执行 前/后置操作,包括断言、提取变量、数据库操作、自定义脚本、公共脚本、等待时间
🔥【新功能】支持自动备份每个模块对应的 OpenAPI/Swagger 文件到 Github 仓库
自动备份 OpenAPI/Swagger 文件到 Github
⚡️【优化】查看团队项目时,支持切换宫格、列表布局,支持切换排序方式
⚡️【优化】配置 JWT 类型的 Auth 时,可以自定义 Authorization Header 名称
⚡️【优化】优化了响应代码编辑器中,添加断言/提取变量功能的显示效果
⚡️【优化】优化了定时任务中的测试场景选择环境的显示效果
⚡️【优化】在线文档配置了自定义域名后,可以禁用 Apifox 提供的域名
⚡️【优化】在线文档配置邮件白名单时,支持自定义 SMTP 服务器、自定义邮件模版
⚡️【优化】在线文档支持配置个人变量是否存储在本地浏览器
🐞 解决调试 gRPC 接口时,发送了重复的 Authorization Metadata 的问题
🐞 解决克隆在线文档得到的项目,Web 端可以正常显示,但客户端没有显示任何接口的问题
🐞 解决部分情况下自动化测试的地址栏显示了错误的前置 URL 的问题
🐞 解决部分情况下批量运行测试后,无法查看测试报告的问题
🐞 解决在子分支批量修改内容后,推送通知中的链接会跳转到主分支的问题
🐞 解决管理迭代分支的弹窗内,子分支的统计数据均为 0 的问题
🐞 解决子分支的接口继承根目录 Auth 时,错误显示为无需鉴权的问题
🐞 解决部分情况下打开项目列表,能看到项目但提示没有权限的问题
🐞 解决部分情况下点击在线文档的 Run in Apifox 后提示没有权限的问题
🐞 解决导入 OpenAPI/Swagger 数据,如果同时使用了 allOf 和 properties,且 properties 的属性又引用了数据模型时,导入失败的问题
🐞 解决定时导入配置了 YAML 格式的 OpenAPI/Swagger 数据源后,点击立即导入按钮无效的问题

2.7.17#

2025-06-11
🐞 解决 2.7.16 特定本地缓存偶现会导致启动自动打开的项目界面报错的问题

2.7.16#

2025-06-11
🔥【新功能】项目支持使用 模块 进行管理,一个 模块 对应一份标准 OAS 文件
Apifox多模块
⚡️【优化】优化了项目导入功能的界面与交互
⚡️【优化】优化了新手引导流程
🐞 解决有时 CLI 运行的测试结果与客户端运行结果不同的问题
🐞 解决二进制响应,点击「仍以文本查看」功能无效的问题
🐞 解决 2.7.15 版本,在客户端批量运行测试场景,测试报告内没有详情的问题
🐞 解决当项目过多时,从团队页导入一个新项目后无法打开此项目的问题

2.7.15#

2025-05-31
🔥【新功能】在线文档新增 SEO 设置,支持配置全局 Metadata、Robots 文件和 Sitemap 文件
🔥【新功能】在线文档支持配置自定义登录页
自定义登录页
⚡️【优化】优化了地址栏中前置 URL 的显示
⚡️【优化】优化了接口列表中目录的菜单项顺序
🐞 解决部分情况下,收藏的项目列表被清空的问题
🐞 解决自动化测试的测试报告,选择全部类型时未显示性能测试报告的问题
🐞 解决运行自动化测试场景后,为接口添加断言或提取变量步骤,无法正常保存的问题
🐞 解决导入 Swagger/OpenAPI 文件时,如果 form-data 的字段示例值是嵌套的 JSON,则导入失败的问题
🐞 解决导出指定版本的数据时,实际导出了主分支的数据的问题
🐞 解决导入的数据模型同时包含 allOf 引用的其他数据模型和 object 时,导出后数据模型引用不正确的问题
🐞 解决 2.7.14 版本“退出登录”功能在启动时自动打开的项目界面里无法正常工作的问题

2.7.14#

2025-05-23
🔥【新功能】调试 SSE 流式响应的 AI 大模型 接口时,自动合并消息内容后,可以预览 Markdown 格式的内容
预览 Markdown 格式内容
⚡️ 【优化】调试接口时,解析域名将优先使用 IPv4 而不是 IPv6
⚡️ 【优化】调试接口时,支持 TLS v1.0 和 v1.1 的 HTTPS 接口
⚡️ 【优化】增加实验性功能:使用独立进程执行 API 请求,开启后可以避免发送请求后内存占用过高的问题
⚡️ 【优化】增加实验性功能:优化本地服务进程内存,开启后可以避免使用本地 Mock 后内存占用过高的问题
实验性功能

2.7.12#

2025-05-17
🔥【新功能】导入/导出项目数据时,支持选择特定 API 版本
🔥【新功能】支持创建并使用组合型鉴权组件
⚡️【优化】将 JSON 粘贴到请求的参数名字段时,其内容将被自动转换为参数名和参数值
自动识别 JSON 参数
⚡️【优化】在线文档配置自定义域名后,如果 CNAME 配置不正确,界面上会给出提示
⚡️【优化】如果隐藏了自动生成的 Header,则 Header 标签上的数字也不包含自动生成的 Header
🐞 解决使用 Socket.IO 发送 JSON 数据时,发送出去的数据格式不是字典而是字符串的问题
🐞 解决在用例复制 cURL 时,cURL 的参数使用了接口的值而不是用例的值的问题
🐞 解决创建在线分享时,无法选择项目中全部自定义字段的问题
🐞 解决导出 Postman 格式时,JSON、XML 格式的 body 类型被转换为 Text 的问题
🐞 解决在项目内邀请成员成功后,团队动态没有正确显示的问题

2.7.11#

2025-05-14
🐞 解决 2.7.10 版本自动化测试的性能测试无法正常工作的问题

2.7.10#

2025-05-13
⚡️【优化】降低启动桌面版 App 后的初始内存占用,解决长时间使用后的内存泄漏问题
⚡️【优化】使用 OIDC 方式与 HashiCorp Vault 集成时,支持 PKCE 授权模式
🐞 解决使用 2.7.8 版本发送 gRPC 请求时,部分接口会报 unresolvable extensions 错误的问题;如果遇到此问题,请升级版本后重新导入 .proto 文件
🐞 解决使用 2.7.9 版本,偶现主窗口 Tab 出现白屏的问题

2.7.9#

2025-05-09
🐞 解决无法通过 服务器反射 方式导入启用了 SSL/TLS 的 gRPC 接口的问题
🐞 解决 2.7.8 版本无法正确展示 gPRC 接口的请求参数和返回响应的数据结构的问题

2.7.8#

2025-05-06
🔥【新功能】在 数据模型 页面,可以查看哪些接口、数据模型、Markdown 文档 引用 了当前数据模型
数据模型引用
🔥【新功能】gRPC 项目 支持通过 服务器反射 导入接口
服务器反射
🔥【新功能】配置 Redis 数据库连接时,支持选择 单机 还是 集群 模式
⚡️【优化】团队成员页面新增 待处理邀请 页面,可以查看已被邀请但尚未接受邀请的邮件地址
⚡️【优化】gRPC 项目 支持切换按 .proto 文件名还是按包名对接口分组
⚡️【优化】批量运行 测试场景 时,可以设置运行完成后是否发送通知
⚡️【优化】导入 Swagger/OpenAPI 文件时,优化了对 Query 参数的 explode 属性的支持
⚡️【优化】导出 Swagger/OpenAPI 文件时,接口顺序和 App 内的保持一致
🐞 解决某些情况下,无法点击 App 顶栏的按钮的问题
🐞 解决打开某些接口文档时,页面失去响应的问题
🐞 解决调试 SSE 接口,自定义 JSONPath 来合并响应内容时,输入特殊字符后页面崩溃的问题
🐞 解决无法保存 Visualize 页面显示的图片的问题
🐞 解决网页版 App 的部分输入框无法正常输入文本的问题
🐞 解决升级到付费版本后,未计算已有测试场景的覆盖率的问题
🐞 解决导入 Swagger/OpenAPI 文件并选择智能合并时,数据模型的参数的枚举值会被清空的问题

2.7.7#

2025-04-19
🔥【新功能】可以为团队配置 IP 允许访问名单,支持 IP 地址和 IP 范围
🔥【新功能】鉴权组件支持迭代分支、版本分支、修改历史记录
⚡️【优化】从数据库导入数据表以创建数据模型时,支持搜索数据库连接
⚡️【优化】统计测试覆盖率时,不再包含已废弃状态的接口
⚡️【优化】导入 Postman 集合时,会导入集合、目录的说明
⚡️【优化】非项目团队的成员访问公开项目时,将无法查看鉴权组件的默认鉴权值
⚡️【优化】在线文档的生成代码功能,支持鉴权组件
🐞 解决无法将接口用例复制为 cURL 的问题
🐞 解决配置数据库连接时,如果参数过长就无法保存配置的问题
🐞 解决通过数据库连接导入数据模型时,不支持配置时使用了变量的数据库的问题
🐞 解决导入 OpenAPI/Swagger 文件时,如果 tag 名称包含 / 和空格,则无法正确创建目录的问题
🐞 解决将项目移交到其他团队后解散原团队,该项目的在线文档无法被访问的问题
🐞 解决特定情况下,使用 Apifox MCP Server 时接口返回 422 错误的问题

2.7.6#

2025-04-11
🔥【新功能】发布/分享的 API 文档,每个页面均提供 .md 格式以供 AI 大模型使用,支持一键复制文档内容;此外,每个文档站均提供 llms.txt、sitemap.xml 和 robots.txt
⚡️【优化】调试 LiteLLM 提供的 AI 大模型接口时,支持自动合并消息内容
🐞 解决通过数据库连接导入数据模型时,点击数据库连接管理后没有打开对应页面的问题

2.7.5#

2025-04-08
⚡️【优化】为发布的在线文档配置邮箱 白名单 时,可以自定义登录页的详细说明与输入邮箱后的提示语

2.7.4#

2025-04-07
🐞 修复了 2.7.3 版本中使用 OpenAPI 格式导入时,特定 body 结构定义无法导入的问题

2.7.3#

2025-04-04
🔥【新功能】上线 鉴权组件 功能,兼容 OpenAPI(Swagger)的 Security Scheme
🔥【新功能】对接口、测试场景进行 评论 时,可以使用 @ 提及团队成员
⚡️【优化】优化了 App 打开项目后的性能
⚡️【优化】导入 OpenAPI 文件时,如果 body 定义了多种 media type,则按照顺序导入第 1 个
⚡️【优化】编辑者角色默认包含手动导入数据的权限
🐞 解决无法批量移动测试场景的问题
🐞 解决当接口定义响应为 No-Content 时,对应的 Mock 服务响应时间过长的问题

2.7.2#

2025-03-21
🔥【新功能】“发布/分享的API文档”全面升级,速度更快、性能更好、优化了移动端的导航和搜索,支持配置单列或双列布局
全新的文档站功能
🔥【新功能】发布的API文档,支持开启MCP功能,文档阅读者可以通过MCP(结合AI编程工具)使用文档
🔥【新功能】自动化测试的测试场景新增评论功能
🔥【新功能】接口、请求 Body、响应 Body 均支持配置 OAS 扩展,全面兼容OpenAPI 规范
🔥【新功能】项目新增支持导出 Postman 格式数据
⚡️【优化】迭代分支 中的文档,支持创建在线文档分享链接
⚡️【优化】导入 cURL 时,将 -b 参数识别为 Cookie
⚡️【优化】优化了数据库连接的 SSH 连接功能
⚡️【优化】可以将通知发送到 Microsoft Teams
⚡️【优化】导出 Swagger 2.0 文件时,如果 file 类型的字段没有指定 consume,则视为 form-data
🐞 解决某些情况下无法通过 SSH 连接 MongoDB 数据库的问题
🐞 解决使用旧版 App 修改新版创建的请求示例数据时,请求示例描述丢失的问题
🐞 解决新建 Socket.IO 接口时添加的 Events 没有被保存的问题
🐞 解决本地运行的测试场景,导出的测试报告没有正确显示接口 URL 的问题
🐞 解决配置自定义权限角色后,角色名没有自动刷新的问题
🐞 解决将较旧的接口选择到子分支后,再在主分支修改接口,接口的创建时间显示错误的问题
🐞 解决 Path 内有单个大括号时,无法将项目导出为 Markdown 文件的问题

2.7.1#

2025-03-12
🐞 解决 2.7.0 版本点击接口文档里的 Mock 的快捷请求时,界面报错的问题
🐞 解决某些情况下本地运行测试场景,导出的测试报告没有正确显示接口 URL 的问题

2.7.0#

2025-03-10
🔥【新功能】Body 支持配置多个 示例,兼容 OpenAPI(Swagger) 规范
请求体多示例
🔥【新功能】请求和响应的每个 示例,都可以配置 说明、OAS 字段名称 和 OAS 扩展 字段
🔥【新功能】支持调试 NDJSON(Newline Delimited JSON)格式的 JSON 流 响应的 HTTP 接口
🔥【新功能】调试 Ollama 本地部署的 AI 大模型 的接口时,Apifox 可以自动合并消息内容,以自然语言展示响应;支持 DeepSeek R1 和 QwQ 32B 等推理模型,可以展示深度思考过程
Ollama
🔥【新功能】支持调试 Socket.IO 接口,可以同时发送多个参数和 Ack
调试 Socket.IO 接口
🔥【新功能】支持导入 SoapUI 的 SOAP 项目
⚡️【优化】当 文档站 配置了邮箱 白名单 时,如果访问者的邮箱不在白名单内,页面不会提示无权限,只是不发送验证码
⚡️【优化】通用接口文档支持配置自定义字段
⚡️【优化】支持配置自定义字段是否必填
⚡️【优化】可以将具备 保护分支修改 权限的用户设置为分支合并的审查人
⚡️【优化】项目 事件通知 的语言会跟随项目语言
⚡️【优化】性能测试 支持使用 脚本 和 数据库连接
⚡️【优化】可以直接在接口目录上进行数据的 导入
🐞 解决使用 Runner 运行自动化测试时,接口设置的重定向规则没有生效的问题
🐞 解决在子分支打开主分支的测试场景后,界面上未正常显示场景名称的问题
🐞 解决在子分支打开主分支的测试场景后,Runner 运行的测试报告显示在主分支的问题
🐞 解决某些情况下调整字体大小功能无法正常工作的问题
🐞 解决某些情况下测试报告的平均请求时间不准确的问题
🐞 解决某些情况下在线文档无法正常显示中文的枚举值的问题
🐞 解决某些情况下无法导入 Knife4j 数据的问题

2.6.51#

2025-03-02
🐞 解决使用 ssh 代理数据库的时候,在数据库列表中修改配置可能会导致无法看到这个配置的问题

2.6.50#

2025-02-23
🔥【新功能】数据库连接 的用户名、密码等信息支持团队成员之间相互同步
⚡️【优化】使用 邮件邀请 新用户加入团队时,只有被邀请的邮箱账号可以加入对应团队,邮件转发无效
⚡️【优化】部署 Runner 时,挂载数据目录默认为空,需要手动填写,以避免用户没有默认目录的访问权限
⚡️【优化】减小了测试报告的文件大小,以提升上传测试报告的速度
⚡️【优化】支持通过带密码的分享链接导入小幺鸡的数据
⚡️【优化】导入 OpenAPI/Swagger 格式的数据时,如果 body 为常见的文件、图片格式,将被导入为 Binary 类型
🐞 解决发送多个同名的 Cookie 时,只发送了第一个的问题
🐞 解决项目的编辑者无法使用定时导入功能的问题
🐞 解决删除子分支关联的接口用例后,导入测试场景会丢失测试步骤的问题
🐞 解决查看测试报告时,断言结果重复显示的问题
🐞 解决在项目列表导入数据时,无法导入环境的问题
🐞 解决导出项目为 OpenAPI/Swagger 格式的数据时,如果接口没有配置鉴权,Security 字段不是空数组而是空对象的问题

2.6.49#

2025-02-15
🔥【新功能】调试 SSE 流式响应的 AI 大模型 接口时,Apifox 可以自动合并消息内容,以自然语言展示响应;且支持展示推理模型(比如 Deepseek R1)的思考过程
SSE流式响应
🐞 解决使用 OAuth 2.0 的 Implicit 授权模式时,给 Auth URL 配置的 Query 参数没有生效的问题

2.6.48#

2025-01-27
🔥【新功能】使用定时任务在 Runner 中运行测试场景,可以选择使用环境/全局变量的 远程值 或 保存在 Runner 中的本地值
选择远程值或本地值
⚡️【优化】接口返回响应的内容格式可以配置为 No-Content,表示接口没有返回任何响应体
⚡️【优化】访问非自己团队的 公开项目 时,接口文档页面不再展示修改者、创建者等信息
⚡️【优化】定时任务中包含的测试场景被修改/删除后,优化了其显示样式
🐞 解决接口仅使用全局参数时,自动化测试无法正确读取前置步骤的响应 Body 的问题
🐞 解决导入 apiDoc 格式的数据时,没有导入 query 部分的问题
🐞 解决在根节点引用的中文名称的数据模型,无法被导出为 Markdown 格式的问题
🐞 解决定时任务的运行历史页面,错误展示了手动指定 Runner 运行测试的测试报告的问题

2.6.47#

2025-01-24
⚡️【优化】如果没有选择任何参数文本,直接右键选择 EncodeURIComponent 编码或 DecodeURIComponent 解码时,视为选择了全部文本
⚡️【优化】通过密码或白名单内的邮箱访问加密的在线文档后,1 个月内无需再次验证密码、邮箱
⚡️【优化】删除项目输入项目名称时,忽略项目名称前后的空格
🐞 解决调试接口时,Cookie 内的一些 = 被移除的问题
🐞 解决某些情况下无法运行测试场景的问题
🐞 解决通过脚本发送请求后,无法在控制台查看请求内容的问题
🐞 解决将脚本作为测试场景的第一个步骤并运行性能测试后,总请求次数为 0 的问题
🐞 解决通过标签筛选要在线分享的内容时,对 Markdown 文档无效的问题
🐞 解决在线文档的自定义域名使用泛域名时,提示证书域名与输入的自定义域名不匹配的问题
🐞 解决某些情况下在线文档没有显示响应示例的问题
🐞 解决无法导入某些版本的小幺鸡数据文件的问题
🐞 解决关闭定时任务的通知后,仍会触发 Webhook 通知的问题
🐞 解决生成代码时,团队变量没有被正确替换的问题

2.6.46#

2025-01-17
🔥【新功能】支持通过 URL 导入 WSDL 文件
🐞 解决仅声明元素限定 elementFormDefault="qualified" 而属性 attributeFormDefault 未配置 的 WSDL 导入问题
🐞 解决 接口运行页与接口用例页 Auth 设置后请求依然使用接口定义的问题
🐞 解决关闭一个 Markdown 文档的编辑时,如果另一个 Markdown 文档的编辑模式处于打开状态,也会关闭这些文档的编辑模式的问题
🐞 解决在 Markdown 文档的标签页打开时,删除该文档会导致 UI 错误的问题

2.6.45#

2025-01-14
🔥【新功能】支持可跨项目使用的 团队变量
团队变量
🔥【新功能】支持在 团队 中部署 请求代理 Agent,可以通过此 Agent 发送接口请求
请求代理 Agent
⚡️【优化】优化了在线文档的本地搜索能力
⚡️【优化】浏览在线文档时,如果窗口较窄,则自动隐藏文档右侧的大纲
🐞 解决接口使用 OAuth 2.0 鉴权,且在 Access Token URL 使用变量时,无法重新获取 Token 的问题
🐞 解决开启兼容 BigInt 后,过长的数字在文档内被转换为科学计数法表示的问题
🐞 解决接口和测试场景合并到主分支后,接口关联的测试场景数据没有更新的问题
🐞 解决配置网络代理后再切换项目,网络代理配置丢失的问题
🐞 解决没有获得运行性能测试权限时,仍可以运行性能测试的问题
🐞 解决将团队转入组织后,在组织内新建团队并邀请组织成员加入,在接受邀请前,该成员看不到组织的问题

2.6.41#

2024-12-27
🔥【新功能】发布文档站支持配置 Google Analytics 统计
Google Analytics
🔥【新功能】CLI 支持指定使用保存在本地文件中的 环境变量、全局变量 本地值
export current value
⚡️【优化】数据库连接使用 SSH 隧道,且验证方法为 公钥 时,支持使用带 口令 的私钥
⚡️【优化】支持为 Markdown 文档配置在目录树中的名称
⚡️【优化】组织、团队、项目中每个成员的 最近活跃时间,不再全局计算,而是按照不同组织、团队、项目为维度分别计算
⚡️【优化】回收站 不再展示已归档分支的资源
⚡️【优化】优化了针对 分支 的权限设置
⚡️【优化】App 内的表单不再关联 1Password 的自动填充功能
⚡️【优化】当 测试场景运行完成 事件触发邮件通知时,邮件的内容新增 运行于 字段,比如:运行于:客户端
⚡️【优化】导出的 OpenAPI/Swagger 文件将会被格式化,不再是一行
⚡️【优化】邀请 其他人加入团队时,默认权限调整为 编辑者,而不是只读
🐞 解决导出 Apifox 格式的文件时,接口顺序与 App 内不一致的问题
🐞 解决查看设置了密码的在线文档时,部分情况下图片无法正常显示的问题
🐞 解决部分情况下无法对版本分支进行冲突处理合并的问题
🐞 解决当标签页过多时,右侧没有显示 + 按钮的问题

2.6.40#

2024-12-18
🐞 解决存在特定环境/全局变量时,打开 HTTP 接口后界面异常的问题

2.6.39#

2024-12-15
🔥【新功能】可以将主分支设置为受 保护,在 迭代分支 提交 MR 然后被 审核 后,才可修改被保护的主分支内容
主分支设置为受保护
🔥【新功能】迭代分支 支持数据的导入和导出
🔥【新功能】可以对接口进行 评论
对接口进行评论
🔥【新功能】可以查看测试场景的修改 历史记录,支持把测试场景 还原 到某个历史版本
测试场景历史记录
🔥【新功能】可以为发布的 文档站 根据 IP 和邮箱设置 白名单
文档站 IP/Email 白名单
⚡️【优化】当迭代分支资源关联的主分支资源更新时,会提示拉取更新
⚡️【优化】优化了处理内容冲突的界面
⚡️【优化】自动化测试的运行完成通知,增加迭代分支与运行环境的信息
🐞 解决修改测试数据并保存时,如果有多页数据,只会保存当前页的问题
🐞 解决无法将测试场景批量移动到根目录的问题
🐞 解决特定情况下,无法运行测试场景的问题
🐞 解决在目录批量运行测试场景后,刷新页面则无法显示测试报告详情的问题
🐞 解决自动化测试中的脚本步骤无法获取前置步骤信息的问题
🐞 解决调整了文档站子站点的版本顺序时,无法克隆主版本的问题
🐞 解决文档站跳转链接错误的问题
🐞 解决首次使用 SSO 登录时,如果 Apifox 账号已经关联了其他的 SSO 身份,无法使用新身份覆盖的问题

2.6.38#

2024-12-11
🐞 解决 2.6.34 ~ 2.6.37 版本中,为 HTTP 接口设置自定义 URL 和 meta 信息没保存的问题

2.6.37#

2024-12-10
🐞 解决 2.6.35 ~ 2.6.36 版本中,存在特定环境/全局变量时,打开 HTTP 接口后界面异常的问题
🐞 解决 2.6.36 版本中,在团队管理界面重命名项目后,无法拖动项目进行排序的问题

2.6.36#

2024-12-07
🐞 解决异步上传测试报告时,偶现上传顺序不对的问题
🐞 解决 2.6.33 版本中,批量运行测试场景 报告没内容的问题
🐞 解决 文档站 中配置的搜索设置,显示不一致的问题
🐞 解决 数据库连接管理 界面,删除操作触发的 二次确认弹窗 样式异常问题
🐞 解决 2.6.34 ~ 2.6.35 版本中,在 团队项目 界面以导入方式新建项目权限不足的问题

2.6.34#

2024-12-06
🔥【新功能】可在团队/组织的成员页中进行 项目角色 自定义,自由设置角色的项目功能权限,再给具体用户指派这个自定义 项目角色。
自定义项目角色
🔥【新功能】项目管理员 可在 项目设置 中查看&管理当前项目成员,并且支持直接将 团队成员 添加进入项目。
成员管理

2.6.33#

2024-11-30
🔥【新功能】接口、接口用例支持查看关联 测试场景,了解当前接口/用例的自动化测试 覆盖情况。同时在 项目概览 页中,支持展示项目的 接口用例覆盖 与 测试场景覆盖 统计数据
关联测试场景
🔥【新功能】支持直接从 测试报告 的响应结果中一键 提取变量、设置 断言
🔥【新功能】选择参数文本后右键点击,可以对其进行 EncodeURIComponent 编码或DecodeURIComponent 解码,也可以将其存入变量
参数编码解码
🔥【新功能】在 项目概览 页可以更方便地导出 OAS 文件,支持配置 标题、版本,以及通过 JSON 或 YAML 配置更多自定义信息
项目概览
🔥【新功能】支持在 组织 中部署 自托管 Runner,组织内的全部团队都可以使用在组织部署的 Runner
🔥【新功能】Vault Secrets 密钥库,支持与外部密钥提供商 集成,例如 HashiCorp Vault、Azure Key Vault 和 AWS Secrets Manager,获取的密钥会加密存储在本地客户端中
⚡️【优化】自动化测试模块,编排模式、运行测试交互优化,能够更好的并行多任务工作
⚡️【优化】支持在 组织 中查看全组织的功能用量
⚡️【优化】如果响应通过了校验,也会显示校验响应结果,更加直观
⚡️【优化】在发布的文档点击 Run in Apifox 可以通过客户端打开项目
🐞 解决 Mock 脚本内 $$.mockRequest.formdata.get() 不生效的问题
🐞 解决自动化测试添加脚本作为步骤时,切换到公共脚本再切回自定义脚本后保存,自定义脚本内容丢失的问题
🐞 解决自动化测试添导入跨项目接口步骤,且接口请求参数引用数据模型时,无法自动生成 body 参数的问题
🐞 解决自动化测试分组内的步骤数量统计,没有包含数据库和脚本的问题
🐞 解决引用其他测试场景,且第一个步骤为脚本,这个脚本步骤不在测试报告内的问题
🐞 解决特定情况下,组织内的某个团队无法创建多个迭代分支的问题
🐞 解决特定情况下,在发布的文档点击 Run in Apifox 后提示没有权限的问题
🐞 解决邀请成员加入组织成功后,站内信没有显示详情的问题
🐞 解决在数据库操作插入动态值,读取变量的表达式错误的问题

2.6.32#

2024-11-21
🐞 解决使用文档模式运行子分支的接口时,部分情况下点击暂存、还原按钮时报错的问题

2.6.31#

2024-11-15
🔥【新功能】发布文档 支持发布多个 文档站,子站点可以自定义发布的内容 发布文档站
🐞 解决使用脚本操作全局 Cookie 时,界面会一直显示加载中的问题
🐞 解决导出定时运行的自动化测试的测试报告时,未包含详情的问题
🐞 解决导入 Swagger/OpenAPI 格式的数据时,没有正确导入 Apifox 扩展的 x-apifox-maintainer 责任人字段的问题

2.6.30#

2024-11-08
⚡️【优化】导入 Postman 集合 时,可以导入集合和目录级别的 前后置脚本
⚡️【优化】导入 Swagger/OpenAPI 文件时,返回响应的 Header 和描述支持 智能合并 和 指定字段覆盖 功能
⚡️【优化】在线文档的示例代码,不再包含 User-Agent 字段
🐞 解决在 Windows 系统将 Apifox 最小化到托盘后,无法通过双击桌面图标唤起软件的问题
🐞 解决接口的 NTLM 鉴权方式不支持 NTLMv2 的问题
🐞 解决通过 SSH 连接数据库时,某些类型的私钥 无法正常使用的问题
🐞 解决测试场景的批量运行页,切换分页时没有带上搜索栏已输入的内容的问题
🐞 解决将在线文档克隆到自己的项目时,Mock 环境会变为 undefined 的问题

2.6.29#

2024-11-05
🐞 解决恢复上一次退出 App 之前未关闭的标签页后,内存占用过高的问题
🐞 解决测试场景页面内存占用过高的问题

2.6.28#

2024-11-02
🔥【新功能】当接口返回响应为 JSON 时,可以直接在响应区域设置 断言、提取变量、复制 JSON Path
提取 JSON 响应
⚡️【优化】优化了 App 的整体界面
⚡️【优化】完善了智能 Mock 的内置规则,Mock Server 可以直接根据常见字段名(比如 name、time、mail、uuid 等)返回符合格式的数据
⚡️【优化】查看接口请求历史时,会自动定位到填写了请求参数的 Tab
⚡️【优化】CLI 和 Runner 支持使用 公钥 作为验证方法进行数据库连接
⚡️【优化】只有将全部团队移出组织后,才可以解散组织
🐞 解决运行自动化测试时,如果有接口请求不通,测试报告的请求时间计算不准确的问题
🐞 解决 integer 和 number 类型的字段如果设置了枚举值为 0,接口文档内没有正确展示这个值的问题
🐞 解决接口文档没有正确渲染复杂的 HTML 表格的问题
🐞 解决导入 Swagger 2.0 格式的数据时,没有正确导入 Apifox 扩展的 x-apifox-enum 对象的 name 和 description 的问题

2.6.27#

2024-10-30
🐞 解决关闭 Windows 版客户端的主窗口后,部分情况下会出现多个无法切换的 Tab 标签页的问题

2.6.26#

2024-10-25
🐞 解决 全局变量 的值为二级或以上嵌套对象时,后置脚本无法正确获取该变量的值,或部分界面出现一直 loading 的问题

2.6.25#

2024-10-25
🔥【新功能】自动化测试 可以添加 脚本 和 数据库连接 作为测试步骤
脚本
数据库连接
⚡️【优化】点击旧版的 动态值 表达式后,将会弹窗并展示匹配到的新版的动态值表达式,点击确定即可替换
动态值
⚡️【优化】项目设置的 兼容带注释的 JSON 开关对 WebSocket 接口生效
⚡️【优化】WebSocket 接口文档可以正常展示通过 JSON Schema 配置的 object 类型的参数
WebSocket
⚡️【优化】在接口的 后置操作 填写 提取变量 和 断言 的名称时,可以使用 动态值 功能
⚡️【优化】可以调整测试场景运行完成后 通知 的默认配置,包含通知条件和通知对象
⚡️【优化】定时任务 可以选择使用同一配置运行,定时器增加按分钟、按天的模式
⚡️【优化】优化了 SEO 设置 的交互
⚡️【优化】发布文档 支持配置文档重定向规则
发布文档
⚡️【优化】配置 SAML 单点登录(SSO)时,如果填写的证书错误,保存时会给出提示
🐞 解决回收站筛选功能的问题
🐞 解决使用网页版的浏览器扩展 Agent 调试接口,如果 Header 内存在中文,发出的请求一直挂起而不是报错的问题
🐞 解决从元数据中心导入 Dubbo 3.x 的接口文档时,部分复杂对象的元素的数据类型没有被正确识别的问题
🐞 解决 TCP (Socket) 接口的数据处理函数,在部分情况下没有执行的问题
🐞 解决部分情况下自动化测试的页面会出现空白的问题
🐞 解决在自动化测试的编排模式修改步骤后,关闭标签页时没有弹窗提示的问题
🐞 解决网页版导出的 YAML 文件格式的 OpenAPI Spec 数据,文件后缀为 .json 的问题

2.6.24#

2024-10-18
🔥【新功能】测试场景、定时任务 被删除后会移至 回收站,可在一定时间内恢复,过期将自动永久删除
回收站
🔥【新功能】导入 Swagger/OpenAPI 文件,匹配到相同接口时,新增 覆盖指定字段 的选项,可自定义选择需要覆盖的字段
覆盖指定字段
🔥【新功能】支持导入 小幺鸡(docway) 的 .mjson 文件
⚡️【优化】团队外的用户通过 Run in Apifox 调试接口时,支持编辑 环境变量 的本地值并保存
⚡️【优化】JSON 请求体中包含多个 动态值 时,即使某个动态值替换失败,其余动态值仍会继续替换
⚡️【优化】测试步骤的 条件分支 ,支持 动态值 功能。
⚡️【优化】可以隐藏在线文档底部的 修改时间
⚡️【优化】自托管 Runner 的 Mock 服务,配置服务器地址时,如果没有填写协议头,则自动补充 http:// 协议
🐞 解决 GraphQL 接口的在线文档错误显示了未定义的 404 响应的问题
为提高页面响应速度,更新日志仅保留最近半年的记录。
上一页
帮助中心
下一页
产品介绍
Built with