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. 发布 API 文档
  • 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. 发布 API 文档

如何在 Apidog 中将 API 分享给协作者?

在 API 开发、沟通与协作中,API 文档在逻辑上是标准做法,但在实际操作中,仍存在通过 Word 或 PDF 格式文件来回传递的问题。因此,推荐使用在线文档来提升团队之间的沟通效率。

创建快速分享#

切换到左侧的 Share Docs 模块。
点击“New”创建一个新的快速分享。一个项目支持多个不同的快速分享,可分发给不同的协作者。每个团队成员都可以看到所有人创建的全部快速分享。
在新建分享弹窗中,你可以自定义以下选项:
标题:此分享的名称,仅在 Apidog 团队内可见,用于内部识别,不会显示在分享出去的文档中。
环境:选择在线文档中可用的环境。默认不选择任何环境。你可以选择多个环境。选中的环境会在文档中对阅读者可见,并且在使用“Try it out”时可用于发送请求。
如果在创建文档时选择 Cloud mock 环境,相当于为文档阅读者启用了一个简单的沙盒环境。
文档内容:文档有两个可选组件:Base URL 和请求示例。你可以选择是否在文档中显示它们。
Base URL:这是在环境中设置的基础 URL。如果选中,文档中的每个接口都会显示完整 URL;如果未选中,文档中的 URL 将以“/”开头。
请求示例:是否显示调用请求的示例代码。详情请参见请求示例。
允许导出数据:是否允许阅读者以 OAS/Markdown/HTML/Apidog 格式导出数据。
分享范围:选择此分享中要包含哪些 API 端点和 Markdown。你可以按目录选择,或按标签筛选和排除。
安全:你可以设置访问此文档是否需要密码,以及此文档的过期时间。如果未选择过期时间,则永不过期。
显示 API 字段:你可以设置这些字段是否显示在文档中。包括:负责人、更新时间、OperationId、原始链接、需要授权。
语言:这里的语言设置会影响文档中的功能性固定文本,例如“Query Params”“Request samples”等,但不会影响 API 文档内容中编写的文本。
高级设置:你可以在此设置隐藏“Try it out”按钮和隐藏“Powered by Apidog”。

分享整个文件夹#

快速分享支持“分享整个文件夹”。这适用于以下场景:分享链接后,你可能在文件夹中新增或删除了文档,并希望协作者能够同步看到这些变更。
在“分享范围”中,当你选择“手动选择”时,可以看到“分享整个文件夹”。如果启用,协作者将始终看到该文件夹中的所有文档,而无需你在新增文档后手动修改分享范围。

请求示例#

你可以在创建分享时选择是否显示此模块。
你可以自定义请求示例。操作方法如下:
1.
在项目设置 - 功能设置 - 端点功能设置 - 端点字段中,启用请求示例字段。
2.
然后在端点 - 编辑中,末尾会出现一个请求示例模块。
3.
你可以点击此处的添加请求示例,添加所需语言的示例。随后它会显示在文档中。
图片.png

分享链接#

设置完成后,复制链接并分享给团队成员。
访问该链接以查看 API 文档。
Modified at 2026-06-09 08:55:47
Previous
当 API 规范更新时,API 文档会变化吗?
Next
如何自定义 Apidog 文档的域名?
Built with