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. 常见问题

发布 API 文档

怎么在发布的文档中隐藏所有 Apifox 的元素（Logo、按钮等）？
进入 “分享文档”，打开 “发布文档站”，点击 “个性化设置 -> 外观设置”。 你可以在打开的面板中隐藏 Powered by Apifox、Run in Apifox、调试等 Apifox 特有元素。 &lt...
当在 Apifox 中更新文档内容时，已发布的线上 API 文档会跟着改变吗？
Apifox的文档内容是实时更新的，始终反映端内 API 文档的变化。 如果你不想 API 文档实时变化，可以使用迭代分支功能。通过在分支中修改 API 文档内容，变更只有在合并到主分支时才会影响到文档。
自定义域名一直显示未生效怎么办？
首先，配置 CNAME 一般需要 10 分钟左右才生效，请耐心等待。如果长时间未生效，可能是以下原因导致： CNAME 配置不成功，请前往域名管理界面，确认 CNAME 是否正确配置。 域名尚未完成备案。 :::tip[了解更多] 自定义域名：CNAME 方式 自定义域名：自有服务器中转方...
如何检查 CNAME 配置是否正确？
Linux 使用 dig 命令检查域名解析是否正常。 dig [你的自定义域名] Windows 系统需要安装 dig 命令，参考此文档安装：安装 dig 命令 命令运行后，查看 ANSWER SECTION 部分是否与 Apifox 上的信息配置一致，例如： 国内服务器都...
Apifox 自定义域名的 SSL 证书生成失败怎么办？
情况一： 证书生成失败，请检查 CNAME 配置是否正确。 情况二： 证书生成成功，但域名无法访问，可能是你的电脑配置问题。建议换一台电脑或使用手机测试，若问题仍然存在，请联系技术支持解决。 无法访问的电脑配置检查： 确认电脑时钟设置是否正确。 访问 ISRG Root X1 证书验...
Apifox 发布文档/快捷分享中，如何让使用者修改请求的 Base URL ？
在 Apifox 发布文档/快捷分享文档中，若想让文档使用者设置修改 Base URL，可通过设置变量的方式轻松实现。具体操作步骤如下： 创建变量并引用变量在 Apifox 项目中，进入某个「环境」页面，点击「添加变量」，输入变量名称（例如“baseUrl”）。在环境对应的前置 URL 中的 UR...
上一页
如何在 PowerShell 中运行 Apifox CLI 命令
下一页
怎么在发布的文档中隐藏所有 Apifox 的元素（Logo、按钮等）？
Built with