Apifox 帮助文档
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. 常见问题
  • 技术支持概览
  • 导入/导出
    • 如何导入接口数据到 Apifox?
    • 如何导入 cURL 到 Apifox？
    • 如何将 Postman 的环境变量迁移到 Apifox？
    • 为什么导出的 API 数量减少了？
    • 为什么导出到 Markdown 和 HTML 时 API 顺序混乱？
    • 如何将文档导出为 PDF/Word？
    • 如何在 Apifox 中导入 Swagger/OpenAPI 时自动将接口分组？
  • 发送请求
    • 为什么参数值中的"+"会被解码成空格？
    • Apifox 是否支持调试 Socket.IO？
    • Apifox 是否支持在 WebSocket 接口中使用前置/后置脚本或者断言？
    • Apifox 是否支持在 gRPC 接口中使用前置/后置脚本或者断言？
    • 为什么发送请求的时候，出现"socket hang up"？
    • 为什么同一个接口客户端请求成功，在web端调试会出现错误："无法请求地址" ？
    • 接口响应过大时，为什么 Apifox 会报错提示超出 nodejs 字符串最大长度？
    • 为什么发送请求，提示“Invalid URI xxx"?
    • 为什么发送请求，提示”Couldn't resolve host“？
  • 设计 API
    • 可以把响应组件作为默认响应吗？
    • 怎么查看是谁修改了接口？
    • 如何在 Apifox 中批量删除目录？
    • 如何在 Apifox 中批量删除接口？
    • 怎么给接口批量添加或删除 URL 前缀？
    • 如果一个字符串属性有多个枚举值，而且在不同地方都用到了，怎么才能保证这个枚举在整个文档里都保持一致？
    • 如何获取 Apifox 的资源目录 ID？
    • 如何在 URL 路径中使用变量？
    • 如何使用 Apifox 录制接口？
    • 在定义接口响应时，是否允许接口没有任何响应内容？
    • 接口/文档/测试场景不小心删除了怎么办？
    • Apifox 是否支持自定义接口的请求代码？
    • 如何在 Apifox 接口列表中设置显示 接口名称 或 接口 URL？
    • 为什么接口定义的字段在文档中看不到？
    • 如何获取项目ID？
    • 如何快速编辑 JSON 数据结构中的必填字段？
  • 调试 API
    • 为什么同样的请求在其它工具（比如 Postman）里能正常工作，但在 Apifox 里却不行？
    • 怎么把其它工具的环境迁移到Apifox？
    • 怎么在 Apifox 里用脚本做断言？
    • JSONPath 只能提取数组，那在 Apifox 里怎么从数组中提取单个元素呢？
    • 在 Apifox 中，不同环境有不同的数据库连接，怎么配置数据库操作？
    • 如何在目录级别添加 header 参数？
    • 如何在自定义脚本中获取服务 baseURL？
    • 如何在 Apifox 自定义脚本中生成动态值？
    • 如何在 Apifox 中查看原始报文？
    • 如何在 Apifox 脚本中发起异步请求？
    • 控制台打印内容大小限制是多少？为什么打印大文件会报错？
    • 如何在接口请求时上传文件？
    • Apifox 中如何设置请求超时时间？
    • 使用 Windows 版本连接 DB2 数据库时报错怎么解决？
    • 如何批量修改 Header 的 User-Agent 字段
    • 接口带上了非预期的 Cookie 怎么处理？
    • 发送请求失败 “Error: getaddrinfo ENOTFOUND xxx.xxx.xxx.xxx” 的原因及排查方法
  • Mock 数据
    • Apifox支持 Mock WebSocket 接口吗？
    • 为什么浏览器请求 Mock 接口没有返回内容？
  • 自动化测试
    • 为什么测试场景 Apifox 客户端运行没问题，但在 Apifox CLI 或 Runner 中运行时却出错了？
    • 为什么无法成功引用前置步骤数据？
    • 在性能测试中怎么查看实际的请求和响应？
    • 在 Apifox 中怎么导出性能测试报告？
    • 如何使用数据库查询得到的数据循环传参给接口运行?
    • 如何解决 "Error: unable to verify the first certificate on runner" 错误？
    • 为什么在 CLI 执行完生成的测试报告，使用 Apifox 客户端查看报告每个 case 的详情都看不到呢？
    • 如何在 Apifox Web 版设置通用 Runner 的服务器 Host？
    • 接口参数是一个上传文件在 Runner、CLI 中找不到怎么办？
    • 当 Runner 发生问题了，如何查询 Runner 日志用以定位？
    • 如何查看 runner 版本号？
    • 使用 Runner 运行测试场景报错，报告提示"unsafe legacy renegotiation disabled"?
    • 为什么linux系统在安装cli后不能直接使用
    • 为什么测试步骤同步不了接口的参数值？
    • 为什么接口用例改了，测试步骤没有自动同步？
    • 如何在 PowerShell 中运行 Apifox CLI 命令
  • 发布 API 文档
    • 怎么在发布的文档中隐藏所有 Apifox 的元素（Logo、按钮等）？
    • 当在 Apifox 中更新文档内容时，已发布的线上 API 文档会跟着改变吗？
    • 自定义域名一直显示未生效怎么办？
    • 如何检查 CNAME 配置是否正确？
    • Apifox 自定义域名的 SSL 证书生成失败怎么办？
    • Apifox 发布文档/快捷分享中，如何让使用者修改请求的 Base URL ？
  • 迭代分支
    • 怎么访问迭代分支？
  • 管理中心
    • Apifox 项目、团队和组织的区别
    • 如何为 Apifox 添加白名单？
    • 如何设置项目权限？
    • 如何设置团队权限
    • 如何邀请已加入团队的成员进入项目？
  • IDEA 插件
    • 为什么通过 idea 插件导入的数据模型名称带有《》？
  • Markdown 相关
    • 如何在 Apifox 的卡片组件中链接到项目内的文档或接口？
    • 怎么在 Apifox 的 Markdown 中使用透明背景图片？
    • 为什么 Markdown 文档中使用多个 $ 时部分内容没有正确显示？
    • 如何在 Apifox 的 Markdown 中编写流程图？
    • 如何控制 Markdown 表格的列宽？
  • 收费与部署
    • Apifox 是否收费？
    • 数据是存储在本地还是云端？可否离线使用？可否私有化部署？
    • 购买【商业专业版】1年，使用半年后升级到【商业旗舰版】，如何计费？
  • Web 端与客户端
    • Apifox alpha 版下载
    • Web 端与客户端有何区别？
    • Web 端与客户端数据不同步如何处理？
    • 为什么Web端发送请求正常，客户端发送请求，出现“read ECONNRESET”？
    • 为什么下载时会跳到百度网盘或天翼网盘？
    • ApifoxAppAgent 进程的作用是什么？
    • Apifox 闪退、白屏怎么办？
    • Apifox 如何打开开发者工具？
    • Apifox 支持 win7 吗?
    • Win 系统自动更新后打不开可能是什么原因？
    • 微信、手机号提示已经被绑定了怎么办？
    • 为什么安装 Apifox 后启动提示"无法定位程序输入点DiscardVirtualMemory 于动态链接库KERNEL32.dll"
  1. 常见问题

自动化测试

为什么测试场景 Apifox 客户端运行没问题，但在 Apifox CLI 或 Runner 中运行时却出错了？
最常见的问题涉及变量的使用。 在 Apifox 本地客户端运行时，使用的是存储在你客户端中的变量的 “本地值”，这个值不会同步到服务器。但在 CLI 或 Runner 中运行时，使用的是存储在服务器上的 “远程值”。 为了确保在本地和远程都能顺利运行，你需要正确设置本地值和远程值，并保持它们一致。
为什么无法成功引用前置步骤数据？
首先，确认你是在 “自动化测试” 模块中使用此功能。“读取前置步骤的运行结果” 只在自动化测试模块有效，不能在接口管理模块使用。 如果你已经在自动化测试模块，请切换到测试报告，查看具体某个接口的“实际请求”标签页，确认请求中引用的前置步骤数据是否已成功填充。 如果实际请求中显示的仍是 {{$.n.r...
在性能测试中怎么查看实际的请求和响应？
Apifox 的性能测试不提供查看实际请求和响应的功能。 这是因为性能测试主要是评估 API 在高负载下的表现，而这些 API 应该已经 100% 通过了功能测试。出现的问题很可能是由服务器性能引起的，而不是请求/响应内容的问题。 因此，查看实际的请求和响应对解决性能相关的问题帮助不大。所以，Api...
在 Apifox 中怎么导出性能测试报告？
性能测试目前还处于测试阶段，Apifox 还不支持导出性能测试报告。你只能在 Apifox 客户端内查看测试结果。
如何使用数据库查询得到的数据循环传参给接口运行?
Apifox 支持使用数据库查询结果循环传参给接口运行。您可以按照以下步骤操作： 在测试场景中添加一个“数据库操作”步骤。执行 SQL 查询，并将查询结果提取到一个变量中（例如：`id` ）。确保 SQL 查询返回的是一个数组格式的结果。 ![](https://api.api...
如何解决 "Error: unable to verify the first certificate on runner" 错误？
在使用 Apifox 的 Runner 运行时，如果遇到 "Error: unable to verify the first certificate on runner" 错误，通常是因为 Runner 无法验证服务器的 SSL 证书。这可能是由于服务器使用自签名证书或证书链中...
为什么在 CLI 执行完生成的测试报告，使用 Apifox 客户端查看报告每个 case 的详情都看不到呢？
在 CLI 命令最后添加上 --upload-report detail 。添加该参数后，重新运行 CLI 命令执行自动化测试场景，生成的测试报告在客户端打开时，即可查看每个 case 的详情。 更多的参数可在此处查看： 参数说明 参数 描述 默认值 --access-token &lt...
如何在 Apifox Web 版设置通用 Runner 的服务器 Host？
由于浏览器的安全限制，Web 版无法通过 HTTPS 访问不安全的 HTTP，因此在 Web 端设置通用 Runner 的服务器 Host 时可能会失败。 请前往 Apifox 客户端进行配置。
接口参数是一个上传文件在 Runner、CLI 中找不到怎么办？
Apifox 只保存文件的本地路径，不保存文件本身。因此，在不同机器上使用 Runner 或 CLI 运行测试时，可能会出现找不到文件的错误。 解决方法： 把文件上传到运行测试场景的服务器上 在 Apifox 中打开对应测试步骤，通过参数的批量操作，将文件路径参数替换为机器上的真实路径，或者替换为...
当 Runner 发生问题了，如何查询 Runner 日志用以定位？
使用 docker ps 命令找到出问题的 Runner 信息； 根据 Runner 容器 ID，使用以下命令查询有效日志```js查看容器ID为 abc123 的最近100行日志，推荐 docker logs --tail 100 abc123 查看过去5分钟内的日志 docker logs ...
如何查看 runner 版本号？
进入团队/组织管理界面，在资源-通用 Runner 中可以查看当前团队/组织已经部署的 Runner 状态和版本号等信息 ![image.png](https://api.apifox.com/api/v1/projects/5097254/resources/500066/image-previ...
使用 Runner 运行测试场景报错，报告提示"unsafe legacy renegotiation disabled"?
当使用 Runner 运行自动化测试场景查看测试报告时，某步骤出现以下报错 error:0A000152:SSL routines:final renegotiate:unsafe legacy renegotiation disabled 可能原因是服务器的 SSL 协议过低，Runner 目前...
为什么linux系统在安装cli后不能直接使用
在系统上全局安装完之后 Apifox CLI 需要在 Linux 系统中创建一个符号链接（Symbolic Link），让系统全局范围内都能直接通过 apifox 命令运行该程序。 [root@bogon bin]# ln -s /home/bjz/node-v22.14.0-linux-x64/b...
为什么测试步骤同步不了接口的参数值？
从接口/接口用例导入的测试步骤，其请求数据可以和关联的接口进行同步。在测试步骤中导入接口/接口用例时可以选择手动同步或自动同步模式。 选择手动同步 当接口发生变更，需要在测试步骤中点击同步按钮,此时会同步接口文档里变动的参数名、Path、Method、前后置操作。 选择自动同步 当接口发生变更，测试...
为什么接口用例改了，测试步骤没有自动同步？
若步骤是从接口用例导入 -且选择复制的方式当接口用例变更时，步骤不会变更，两者不存在关联关系。 若步骤是从接口用例导入 -且选择”引用“的方式在接口用例中的任何变动都会同步到此测试步骤内容，反之步骤修改也会同步到接口用例。 因此如果需要测试步骤与接口用例保持完全同步时，请选择引用的方式导入步骤。...
如何在 PowerShell 中运行 Apifox CLI 命令
PowerShell 运行 Apifox CLI 命令 报错apifox: could not find "html cli" reporter PowerShell 不支持 html,cli 这个传参，可以尝试加个引号'html,cli'再传参，例如： apif...
上一页
为什么浏览器请求 Mock 接口没有返回内容？
下一页
为什么测试场景 Apifox 客户端运行没问题，但在 Apifox CLI 或 Runner 中运行时却出错了？
Built with