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
  • 🇨🇳 繁體中文
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. Learning Center
  • 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 桌面版的下载与安装
  1. Learning Center

发布 API 文档

如何在已发布的文档中隐藏所有 Apidog 标志？
“Build with Apidog”标记目前默认显示在已发布的文档中。若要隐藏此标记，需要使用 [Enterprise plan](https://apidog.com/pricing/)。 升级到 Enterprise plan 后，请通过电子邮件 support@api...
当 API 规范更新时，API 文档会变化吗？
Apidog 的文档内容会实时更新，始终反映 API 规范中的变更。 如果你不希望 API 文档实时变化，可以使用 Sprint 分支功能。通过在分支中修改 API 定义，变更只有在合并到 main 后才会影响文档。
如何在 Apidog 中将 API 分享给协作者？
在 API 开发、沟通与协作中，API 文档在逻辑上是标准做法，但在实际操作中，仍存在通过 Word 或 PDF 格式文件来回传递的问题。因此，推荐使用在线文档来提升团队之间的沟通效率。 创建快速分享 切换到左侧的 Share Docs 模块。 点击“New”创建一个新的快速分享。一个项目支持多个...
如何自定义 Apidog 文档的域名？
默认情况下，你的文档可通过 [subdomain].apidog.io 域名访问。不过，你可以通过设置自定义域名来进行自定义，这意味着你的受众将能够在符合你组织需求的域名上访问你的文档。 具有管理员权限的用户可以设置自定义域名。请按照以下步骤设置自定义域名。 开始自定义域名设置 你可以在项目的 Sh...
如何在 Apidog 中创建多版本文档？
进入项目后，你可以在文件夹树上方的迭代分支切换组件中找到“API Versions”选项。点击它后，你将看到当前项目中所有可用的 API 版本。 点击“New API Version”后，系统会提示你输入版本号并选择初始版本内容。默认情况下，它会从其他现有 API 版本创建一个完整副本。如果选择此...
Apidog 中发布文档站点的共享范围
问：Apidog 是否支持为发布文档站点选择特定端点/文件夹/Markdown 范围的选项？ 答：是的，Apidog 支持此类筛选，因此你可以通过已发布的文档选择性地让自定义受众查看特定项目。但此选项仅支持子站点，根站点不具备范围设置功能。 问：如何为发布文档站点设置范围？答：这个范围设置仅支持 未...
Apidog 中 Share Doc 列表的共享范围
问：通过 Share Doc 共享时，我可以选择特定文件夹、端点或 markdown 文件吗？ 答：可以，Apidog 支持选择性共享端点/markdown/文件夹到 Share Docs。 问：如何确保我的共享文档中只显示选定的端点和文件夹？ 答：你可以在新的或现有的 Shared Doc Lis...
为什么已发布的共享文档没有显示主机名？
1. 为什么在试用分支 API 版本时不显示主机名？ 在 Apidog 中使用一个或多个版本的 API 托管站点时（例如，为每个版本设置单独的环境），Try it 功能不会始终如一地显示环境的主机名或变量。除非在发布时设置了 Environment，否则该问题也可能发生在 API 的主版本上。 2....
文档用户如何在共享文档中修改 Base URL？
在 Apidog 的已发布文档或快速共享文档中，如果你希望文档用户能够设置和修改 Base URL，可以通过设置变量轻松实现。具体操作步骤如下： 在 Apidog 项目中，进入某个“环境”页面，点击“添加变量”，并输入变量名称（例如“BaseURL”）。在该环境的“Base URL”对...
我可以复制已发布的 Apidog 文档用于自己的项目吗？
如果你正在使用 Apidog 中的外部接口文档或公共项目，并希望将其复制到自己的工作区，可以通过导出为 Apidog 格式的文档，或根据文档所有者设置的权限克隆它来实现。 操作方法如下： 检查导出或克隆权限 访问分享给你的文档链接，并在接口页面底部查找“Export”或“Clone”按钮。 ...
如何在 Apidog 在线文档中共享头部（例如 Token）？
每次使用 “Try It” 测试 API 时，我都必须手动输入相同的头部。有没有办法自动共享它？ 可以。建议使用变量在 API 请求之间共享头部。以下是两种常见方法： 方法 1：直接在 API 的头部中使用变量 在你的 API 定义中像这样设置头部： Authorization: Bearer {{...
为什么我的团队成员找不到已发布的文档？
Q: 我的团队成员说“Share Docs”部分是空的，尽管我已经发布了一个文档。为什么会这样？ A: 在 Apidog 中，只有对项目拥有 Admin 权限的团队成员才能在 Share Docs 下查看已发布的文档。 如果成员被分配为 Editor 或 Read-only，则他们将无法看到已发布的...
如何修复自定义域名上的 SSL 证书过期或 Cloudflare 526 错误？
Q: 为什么我的自定义域名显示“Certificate has expired”？ A: 这是因为启用了 Cloudflare 的代理（橙色云朵）。当 Cloudflare 接管 HTTPS 时，Apidog 颁发的 SSL 证书将不再被使用，因此看起来像是已过期。 Q: 如何解决证书过期或 ...
自定义 SMTP 配置成功，但允许列表用户未收到 OTP 邮件
问题描述 发布文档站点并启用 Email Allowlist 后，用户需要通过电子邮件接收一次性密码（OTP）才能访问文档。 已完成以下设置： 已启用自定义 SMTP 服务器 已配置 SMTP 主机、端口、用户名和密码 SMTP 配置测试通过（例如，通过 cURL） 但是，在实际使用中，允许列表...
Previous
如何在单次自动化测试运行期间保持动态值一致？
Next
如何在已发布的文档中隐藏所有 Apidog 标志？
Built with