Apidog Docs
🇨🇳 简体中文
🇺🇸 English
🇯🇵 日本語
🇪🇸 Español
🇰🇷 한국인
🇨🇳 简体中文
🇵🇹 Português (Portugal)
🇮🇩 Bahasa Indonesia
🇧🇷 Português (Brasil)
🇻🇳 Tiếng Việt
🇨🇳 繁體中文
🇨🇳 简体中文
🇺🇸 English
🇯🇵 日本語
🇪🇸 Español
🇰🇷 한국인
🇨🇳 简体中文
🇵🇹 Português (Portugal)
🇮🇩 Bahasa Indonesia
🇧🇷 Português (Brasil)
🇻🇳 Tiếng Việt
🇨🇳 繁體中文
🇨🇳 简体中文
🇺🇸 English
🇯🇵 日本語
🇪🇸 Español
🇰🇷 한국인
🇨🇳 简体中文
🇵🇹 Português (Portugal)
🇮🇩 Bahasa Indonesia
🇧🇷 Português (Brasil)
🇻🇳 Tiếng Việt
🇨🇳 繁體中文
Home
Learning Center
Support Center
API References
Download
Changelog
Home
Learning Center
Support Center
API References
Download
Changelog
Learning Center
Copy Page
Back to home
支持中心
Apidog 支持中心
导入/导出
如何将 API 数据导入 Apidog?
如何在 Apidog 中导入 cURL?
如何将 Postman 环境迁移到 Apidog?
如何在导入 Swagger/OpenAPI 时自动对端点分组?
发送请求
Apidog 支持 Socket.IO 吗?
为什么参数值中的 “+” 会被解码为空格?
如何在 Apidog 中发送请求?
如何在 Apidog 中发送 graphQL 请求?
如何在 Apidog 中发送 gRPC 请求?
如何在 Apidog 中发送 SOAP/WebService 请求?
如何在 Apidog 中发送 WebSocket 请求?
Apidog 是否支持 WebSocket API 中的预请求/测试脚本和断言?
如何在 Apidog 中发送 SSE 请求?
如何在文件夹级别添加默认头部?
Apidog 是否支持 gRPC API 中的预请求/测试脚本和断言?
ELANREFUSED.DNS 解析器错误
为什么我在发送请求时会收到 “socket hang up” 错误?
修复请求错误
修复 read ECONNRESET 错误
修复 ECONNREFUSED 错误
修复 ETIMEDOUT 错误
修复 ENOTFOUND: Couldn't resolve host 错误
修复 ENOTFOUND: getaddrinfo ENOTFOUND www 错误
修复 connect EHOSTUNREACH 错误
设计 API
如何在路径中使用变量?
我可以将响应组件用作默认响 应吗?
如何查看谁修改了端点?
如何在 Apidog 中批量删除端点文件夹?
如何批量为端点路径添加/移除前缀?
如何在 Schema 编辑器中移动属性的层级?
如果一个字符串属性有多个枚举值,并且会在多个位置使用,如何在整个文档中一致地引用这个枚举?
如何获取 Apidog 资源文件夹 ID?
如何获取 Apidog 的资源文件夹 ID?
如何在 URL 路径中使用变量?
如果端点、文档或测试场景被意外删除,我该怎么办?
Apidog 是否支持自定义端点的请求代码?
将 Swagger/OpenAPI 导入 Apidog 时,如何自动对端点分组?
如何在模拟响应中生成不重复的数组数据?
为什么路径中不支持输入 "#"?
调试 API
Apidog 如何与第三方密钥管理系统集成?
为什么同一个请求在其他工具(如 Postman)中可以正常工作,但在 Apidog 中不行?
如何在 Apidog 中从数据库获取变量值?
如何将环境从其他工具迁移到 Apidog?
如何在 Apidog 中使用脚本进行断言?
JSONPath 只能提取数组。如何在 Apidog 中从数组 中提取单个元素?
当不同环境具有不同的数据库账号凭据时,如何在 Apidog 中配置数据库操作?
如何在自定义脚本中获取服务基础 URL?
当 API 响应过大时,为什么 Apidog 会报告超出最大 Node.js 字符串长度的错误?
控制台打印的大小限制是多少?为什么打印大文件时会出现错误?
如何解决 Windows 上的 DB2 数据库连接错误?
为什么我在 Apidog 中连接 Oracle 数据库时会遇到错误 NJS-045?
如何在 Apidog 自定义脚本中生成动态值?
为什么客户端请求同一个端点可以成功,但在 Web 端调试时却出现错误:“Unable to request address”?
为什么响应过大时 Apidog 会报错?
如何使用 Apidog 录制端点?
定义端点响应时,是否允许端点没有响应内容?
如何在自定义脚本中获取服务的 baseURL?
如何在 Apidog 中查看原始报文?
为什么在发起请求时会看到 “Invalid URI xxx” 错误?
如何在 Apidog 脚本中发起异步请求?
为什么发送请求时会看到 “Couldn't resolve host” 消息?
控制台打印大小限制是多少?为什么打印大文件时会报错?
如何在端点请求中上传文件?
如果 Apidog 崩溃或响应数据不显示,该怎么办?
Apidog 用于 OAuth2.0 的官方重定向 URI
Mock API 数据
如何自动模拟 API?
Apidog 模拟可以做什么?
如何在 Apidog 中模拟固定 API 数据?
如何在 Apidog 中模拟条件数据?
如何在 Apidog 中启用云端模拟?
如何在 Apidog 中启用自托管模拟?
Apidog 支持模拟 WebSocket API 吗?
为什么浏览器请求模拟端点时不返回内容?
自动化测试
为什么测试场景在我的本地客户端运行没有问题,但在 Apidog CLI 或运行器中运行时会出错?
如何在 Apidog 中创建测试场景?
如何在测试步骤之间传递数据?
为什么我无法成功引用前置步骤数据?
如何在 Apidog 中使用 foreach 循环?
从端点/端点用例同步数据有哪些区别?
如何在 Apidog 中使用测试数据?
如何在 Apidog 的脚本中检索测试数据?
如何在 Apidog 中批量运行测试场景?
如何在 Apidog 中安排测试任务?
如何在 Apidog 中运行性能测试?
如何在性能测 试中查看实际请求和响应?
如何在 Apidog 中导出性能测试报告?
如何使用数据库查询结果作为循环 API 请求的参数?
在 CI/CD 期间使用 ApiDog 捕获并验证 Stripe Webhook
如何解决“Error: unable to verify the first certificate on runner”错误?
General Runner Docker 容器 “Not Found” 错误。
如何在 Apidog Web 版中为通用 Runner 设置服务器 Host?
为什么定时测试场景最终显示 0 个请求?
如果在 Runner 或 CLI 中找不到文件上传参数,我该怎么办?
如何使用 Runner 运行包含上传文件步骤的测试场景?
如何解决“Error: unable to verify the first certificate on runner”错误?
当 Runner 出现问题时,如何访问和搜索 Runner 日志以识别问题?
如果端点参数是上传文件,并且在 Runner 或 CLI 中找不到,我该怎么办?
为什么 API 用例变更时测试步骤不会自动同步?
为什么在 Markdown 文档中使用多个美元符号会导致某些内容无法正确显示?
自托管 Runner 在执行任务后会在服务器上生成测试报告吗?
我可以为测试场景中的请求添加统一的前置/后置处理器吗?
如何在单次自动化测试运行期间保持动态值一致?
发布 API 文档
如何在已发布的文档中隐藏所有 Apidog 标志?
当 API 规范更新时,API 文档会变化吗?
如何在 Apidog 中将 API 分享给协作者?
如何自定义 Apidog 文档的域名?
如何在 Apidog 中创建多版本文档?
Apidog 中发布文档站点的共享范围
Apidog 中 Share Doc 列表的共享范围
为什么已发布的共享文档没有显示主机名?
文档用户如何在共享文档中修改 Base URL?
我可以复制已发布的 Apidog 文档用于自己的项目吗?
如何在 Apidog 在线文档中共享头部(例如 Token)?
为什么我的团队成员找不到已发布的文档?
如何修复自定义域名上的 SSL 证书过期或 Cloudflare 526 错误?
自定义 SMTP 配置成功,但允许列表用户未收到 OTP 邮件
Markdown
如何使用卡片链接到 Apidog 内的各个页面或端点?
为什么在 Markdown 文档中使用多个 $ 符号时,部分内容无法正确显示?
如何在 Apidog Markdown 中使用透明背景图片?
如何设置 Markdown 表格的列宽?
如何将内部 API、文档、数据模式或文件夹插入到 Markdown 文档中?
如何在 Apidog 卡片组件中添加指向项目内文档或端点的链接?
分支
如何访问迭代分支?
管理
如何静默安装 Apidog 客户端?
为什么我明明拥有管理员权限,却看到“No Permission”错误?
如何查看 Runner 版本号?
Apidog 支持 win7 吗?
为什么安装后 Apidog 显示错误“Cannot locate program entry point DiscardVirtualMemory in dynamic link library KERNEL32.dll”?
订阅变更和退款
Web 请求有效,但应用出现 “read ECONNRESET”——为什么?
Windows 系统更新后为什么无法打开 Apidog?
为什么 Windows 系统更新后 Apidog 无法打开
计费
我可以在 Apidog 中为我的团队设置单独的账单账户吗?
Apidog 上的团队访问与计费问题
受邀团队成员无法访问 Apidog。
将个人付费团队转移到组织
私有化部署
Apidog 自托管(企业)版本中的用户和访问管理
Web 与客户端
Linux 桌面版的下载与安装
Learning Center
Copy Page
调试 API
Apidog 如何与第三方密钥管理系统集成?
我们正在开发与 Azure Key Vault、HashiCorp Vault 和 AWS Secrets Manager 的集成,预计将于 2024 年 12 月发布。
为什么同一个请求在其他工具(如 Postman)中可以正常工作,但在 Apidog 中不行?
如果请求完全相同,那么无论使用哪种工具,响应也应该完全相同。如果你得到的响应不同,可以切换到“实际请求”标签页,并与你在其他工具中发送的请求进行对比,以找出差异。
如何在 Apidog 中从数据库获取变量值?
Apidog 提供了一项独特功能:连接到数据库以检索数据,将其设置为变量,并在请求中使用。步骤如下: 在 **Run** 选项卡(DESIGN 模式)或 **Request** 选项卡(DEBUG 模式)中,导航到后置处理器。 将鼠标悬停在“Add PostPro...
如何将环境从其他工具迁移到 Apidog?
在 Apidog 中,变量的初始值会在团队内同步,而当前值仅存储在本地。这意味着,当你在另一台电脑上使用 Apidog 时,将无法访问之前使用过的当前值。 因此,Apidog 提供了迁移环境的功能。 你可以将环境中的服务和变量导出为 JSON 文件,然后在另一台电脑上导入。步骤如下: 在环境...
如何在 Apidog 中使用脚本进行断言?
在 Apidog 中,你可以使用 pm.test 语法通过脚本创建断言。Apidog 兼容 Postman 脚本,允许用户无缝利用现有脚本。 :::highlight purple了解更多关于脚本的信息。:::
JSONPath 只能提取数组。如何在 Apidog 中从数组中提取单个元素?
JSON 是最常用的响应数据格式,而 JSONPath 是一种广泛用于在 JSON 结构中提取数据的语法。Apidog 提供了一个可视化的 JSONPath 提取工具,用于简化 JSONPath 表达式的编写过程。以下是如何有效使用该工具的指南: 点击位于 JSONPath 输入框右侧的 ...
当不同环境具有不同的数据库账号凭据时,如何在 Apidog 中配置数据库操作?
在使用测试环境、生产环境等多个环境时,它们通常会配置不同的数据库。如果你在工作流中使用数据库操作,这意味着这些操作需要随着环境切换而切换。 在这种情况下,你可以在 Apidog 的“数据库连接”设置中配置多个数据库连接。通过为每个环境设置数据库连接,可以确保当你使用右上角的下拉菜单在环境之间切换时,...
如何在自定义脚本中获取服务基础 URL?
Apidog 提供了 pm.request.getBaseUrl(),用于检索当前端点的基础 URL。 建议使用此方法,而不是 pm.environment.get('BASE_URL'),因为如果端点未使用默认服务器,后者可能无法返回正确的基础 URL。 有关服务和基础 URL 的...
当 API 响应过大时,为什么 Apidog 会报告超出最大 Node.js 字符串长度的错误?
当处理过大的 API 响应时,Apidog 的前端可能会遇到与 Node.js 字符串长度限制相关的问题。Node.js 使用 V8 引擎,而 V8 对单个字符串的长度有限制,通常约为 337MB。当响应大小超过此限制时,可能会导致内存不足或字符串处理错误,从而导致 Apidog 报告已超出最大 N...
控制台打印的大小限制是多少?为什么打印大文件时会出现错误?
Apidog 的控制台打印大小限制为 1024 * 1024 字节(1MB)。这是 Node.js 的限制,目前 Apidog 不支持配置此限制。如果打印的文件内容超过此限制,将会发生错误。
如何解决 Windows 上的 DB2 数据库连接错误?
如果你在 Apidog 中连接 DB2 数据库时遇到错误 Error: The specified module could not be found.,通常是由于缺少环境变量。你可以通过配置以下环境变量来解决此问题: 配置 PATH 环境变量:将 <Apidog Installation ...
为什么我在 Apidog 中连接 Oracle 数据库时会遇到错误 NJS-045?
“NJS-045: cannot load a node-oracledb binary for Node.js 18.18.2 (darwin arm64)” 出现此问题是因为 Oracle 目前对 ARM64 架构存在兼容性限制。因此,oracledb 驱动目前不支持 ARM64。
如何在 Apidog 自定义脚本中生成动态值?
PM Script API Apidog 支持在自定义脚本中生成动态值,使用 pm.variables.replaceInAsync(variableName:String):function 方法将字符串中的“动态值表达式”替换为实际值。该函数返回一个 Promise,调用时必须添加 await。...
为什么客户端请求同一个端点可以成功,但在 Web 端调试时却出现错误:“Unable to request address”?
在线文档或 Web 调试期间无法请求地址? 当你尝试在 Apidog 共享的文档中调试端点时,出现错误 “Unable to request the address”,可能原因如下: 浏览器证书问题:如果你的请求是 HTTPS,端点可能会在请求期间重定向到 443 端口。由于客户端可以设置为忽略证...
为什么响应过大时 Apidog 会报错?
当处理超大的接口响应时,Apidog 的前端可能会遇到与 Node.js 字符串长度限制相关的问题。Node.js 使用 V8 引擎,该引擎对单个字符串的长度有限制,通常约为 337MB。当响应大小超过此限制时,可能会导致内存不足或字符串处理错误。
如何使用 Apidog 录制端点?
Apidog 目前暂不支持自动录制端点功能,但未来计划支持该功能。 目前有一种快速录制的方法:在浏览器中测试端点时打开 DevTools。操作完成后,右键导出 HAR 文件,并一键导入到 Apidog 中。创建一个测试场景并导入所有请求,即可随时回放。有关如何导入 HAR 文件的详细信息,请参阅导入...
定义端点响应时,是否允许端点没有响应内容?
如果升级到最新版本,端点定义支持将响应的内容格式设置为 No-Content,这意味着没有响应主体。
如何在自定义脚本中获取服务的 baseURL?
Apidog 提供了 pm.request.getBaseUrl() 方法,用于获取当前端点的 baseURL。 建议使用上述方法,而不是 pm.environment.get('BASE_URL'),因为如果端点未使用默认服务,后者可能无法返回正确的 baseURL。 此外,你可以...
如何在 Apidog 中查看原始报文?
Apidog 不需要打印到控制台,返回消息中有一个 “Actual Request” 标签页,你可以在该标签页中直接查看原始请求报文。 ,请确保父文件夹和根文件夹都已正确配置其 Base URL(即不为空)。你可以阅读 环境与变量 验证 Base URL 是否使用变量定义。 如果 Base URL 使用了变量,请确保对应的全局变量或环境变...
如何在 Apidog 脚本中发起异步请求?
Apidog 支持在自 定义脚本中使用 pm.sendRequest 函数来发起异步请求。详情请参阅 Apidog Postman 脚本参考。
为什么发送请求时会看到 “Couldn't resolve host” 消息?
需要检查端点的 Base URL 是否缺少 “/”。 如果 API 的 URL 包含环境变量,请检查该变量的值是否不正确。
控制台打印大小限制是多少?为什么打印大文件时会报错?
Apigog 的控制台打印大小限制为 1024 * 1024字节(1MB)。这是 Node.js 的限制,目前 Apidog 不支持对此限制进行配置修改。如果打印文件的内容过大并超过此限制,将会报错。
如何在端点请求 中上传文件?
如果你需要为 API 请求上传文件,需要将请求主体切换为 form-data 格式,并将对应字段设置为文件类型,然后即可上传文件。
如果 Apidog 崩溃或响应数据不显示,该怎么办?
发生了什么? 这种情况非常少见,但你可能偶尔会遇到 Apidog 崩溃;当你重新打开它时,API 调用的响应数据可能不会显示。相反,你可能会看到一个加载动画,随后出现一条消息:“点击发送以获取响应。” 我们知道这可能会让人烦恼,我们会帮助你让一切重新顺畅运行! ![图片.png](https...
Apidog 用于 OAuth2.0 的官方重定向 URI
Q: Apidog 用于 OAuth2.0 认证的官方重定向 URI 是什么? A:在 Apidog 中为你的 API 设置 OAuth2.0 认证时,你可能需要在授权服务器或客户端设置中注册一个官方重定向 URI。这可确保 OAuth 流程能够成功完成,并且 Apidog 能够在授权后接收访问令牌...
Previous
为什么路径中不支持输入 "#"?
Next
Apidog 如何与第三方密钥管理系统集成?