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

可以把响应组件作为默认响应吗?
不可以。 响应组件主要用于通用的错误响应,比如 400、404 这类状态码。如果你需要使用固定的默认响应,请直接用默认响应模板。
怎么查看是谁修改了接口?
点击接口右上角的历史记录,就能看到所有以前的修改记录,可以还原到某个版本。
如何在 Apifox 中批量删除目录?
目前,Apifox 还没有批量删除目录的功能,你只能一个一个地删除每个目录。 如果需要批量接口,可以在项目的 “根目录” 中筛选接口来删除。
如何在 Apifox 中批量删除接口?
如果需要批量接口,可以在项目的 “根目录” 中筛选接口来删除。 如何批量删除目录? 目前,Apifox 还没有批量删除目录的功能,你只能一个一个地删除每个目录。
怎么给接口批量添加或删除 URL 前缀?
Apifox 目前不支持通过批量操作来修改接口 URL。不过你可以这样做: 先从 “项目设置 -> 导出数据” 里把文件导出成 Apifox 格式。 然后用文本编辑器 *(比如 VSCode)* 批量查找并进行替换。 最后再...
如果一个字符串属性有多个枚举值,而且在不同地方都用到了,怎么才能保证这个枚举在整个文档里都保持一致?
你可以把这个属性定义成一个单独的数据模型,里面就一个属性。这样你就能在 API 文档的不同地方统一引用它了。例如:
如何获取 Apifox 的资源目录 ID?
点击目录,打开目录设置页面,即可找到目录 ID ![](https://api.apifox.com/api/v1/projects/5097254/resources/493601/image-preview)
如何在 URL 路径中使用变量?
在 Apifox 中,路径中的变量部分我们通常会定义为一个路径参数。例如输入{petId},可以在下方看到 Path 参数。此时可以定义参数值为引用全局变量/环境变量值,例如 {{id}}。设置后当你发送请求时,实际请求中路径会被替换成变量 id 的实际值。 ![image.png](https:...
如何使用 Apifox 录制接口?
Apifox 目前暂不支持自动录制接口功能,但未来有计划支持。 目前提供一种快速录制的方式:在浏览器中测试接口时,打开开发者工具(DevTools)。操作完成后,右键导出 HAR 文件,然后一键导入 Apifox 中。创建一个测试场景并将所有请求导入即可随时回放。导入 Har 文件的方式可以参考 导...
在定义接口响应时,是否允许接口没有任何响应内容?
麻烦升级到最新版,接口定义中支持将响应的内容格式设置为 No-Content,表示没有响应体。 ![image.png](https://api.apifox.com/api/v1/projects/5097254/resources/494768/image-preview)
接口/文档/测试场景不小心删除了怎么办?
Apifox 支持回收站功能,您可以轻松恢复误删的接口、目录、数据模型、测试场景等资源。 点击 Apifox 页面右下角的回收站图标。 选中需要恢复的资源(支持多选) 点击“恢复”按钮即可。 此外,如果误改了接口、文档、数据模型,您还可以通过历史记录恢复到之前的版本: 打开需要恢复的接口。 点...
Apifox 是否支持自定义接口的请求代码?
Apifox 支持在接口中自定义示例代码。您可以按照以下步骤操作: 进入项目设置 -> 功能设置 -> 接口功能设置,将接口字段中的示例代码开关打开 ![image.png](https://api.apifox.com/api/v1/projects/5097254/resour...
如何在 Apifox 接口列表中设置显示 接口名称 或 接口 URL?
为什么接口定义的字段在文档中看不到?
Apifox 文档中请求/响应参数的可见性受高级设置中的行为属性控制。请检查对应字段的高级设置行为是否设置了Read Only 或 Write Only Read Only:用作请求参数时,该字段将被隐藏 Write Only:用作返回结构时,该字段将被隐藏 ![image.png](ht...
如何获取项目ID?
Apifox 中查看项目 ID 的方法: 打开项目。 点击左侧导航栏的“项目设置”。 在“通用设置”中选择“基本设置”。 在“基本信息”中找到“项目ID”,点击即可复制。 <img src="https://api.apifox.com/api/v1/projects...
如何快速编辑 JSON 数据结构中的必填字段?
Apifox 提供了便捷的方式来快速调整 JSON 数据结构中的必填字段。您可以通过修改 JSON Schema 中的 required 属性值来实现。 例如,如果您的数据结构中只有 id 字段为必填字段,而需要将其他字段设置为非必填,可以按照以下步骤操作: 打开 JSON Schema 编辑器。...
上一页
为什么发送请求,提示”Couldn't resolve host“?
下一页
可以把响应组件作为默认响应吗?
Built with