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
  • 🇨🇳 繁體中文
Learning Center
HomeSupport CenterAPI ReferencesDownloadChangelog
Learning Center
HomeSupport CenterAPI ReferencesDownloadChangelog
  1. 发布 API 文档
  • Apidog 学习中心
  • 入门
    • Apidog 简介
    • Apidog 中的基本概念
    • 导航 Apidog
    • 快速开始
      • 概述
      • 创建端点
      • 发送请求
      • 添加断言
      • 创建测试场景
      • 共享 API 文档
      • 探索更多
    • 迁移到 Apidog
      • 概述
      • 手动导入
      • 定时导入(绑定数据源)
      • 导入选项
      • 导出数据
      • 导入自
        • 从 Postman 导入
        • 导入 OpenAPI 规范
        • 导入 cURL
        • 导入 Markdown
        • 从 Insomnia 导入
        • 从 apiDoc 导入
        • 导入 .har 文件
        • 导入 WSDL
  • Mock API 数据
    • 概述
    • Smart Mock
    • 自定义模拟
    • 模拟优先级顺序
    • 模拟脚本
    • 云端模拟
    • 自托管 Runner 模拟
    • 模拟语言(区域设置)
  • 账号与偏好设置
    • 账户设置
    • 生成 OpenAPI 访问令牌
    • 通知
    • 语言设置
    • 快捷键
    • 网络代理配置
    • 备份数据
    • 更新 Apidog
    • 删除账户
    • 实验性功能
  • 发送请求
    • 概述
    • SSE 调试
    • MCP 客户端
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP 或 WebService
    • GraphQL
    • gRPC
    • 使用请求代理 Agent 进行调试
    • 创建请求
      • 请求历史
      • 请求基础
      • 参数和主体
      • 请求头部
      • 请求设置
      • 调试请求
      • 将请求保存为端点
      • HTTP/2
    • 身份验证与授权
      • 概述
      • CA 和客户端证书
      • 授权类型
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk 身份验证
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • 响应和 Cookie
      • 查看 API 响应
      • 管理 Cookie
      • 概述
  • 开发和调试 API
    • 概述
    • 生成请求
    • 发送请求
    • 调试用例
    • 测试用例
    • 动态值
    • 验证响应
    • Design-First vs Request-First
    • 生成代码
    • 环境与变量
      • 概览
      • 使用变量
      • 环境管理
    • Vault 密钥
      • 概述
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • 动态值模块
      • Airline
      • 动物
      • 颜色
      • 商务
      • Company
      • 数据库
      • 数据类型
      • 日期
      • Finance
      • 食物
      • Git
      • Hacker
      • Helpers
      • 图像
      • Internet
      • 位置
      • Lorem
      • 音乐
      • 数字
      • Person
      • 电话
      • 科学
      • String
      • System
      • Vehicle
      • Word
    • 前置和后置处理器
      • 概述
      • 断言
      • 提取变量
      • 等待
      • 安全
      • 数据库操作
        • 概述
        • MySQL
        • MongoDB
        • Redis
        • Oracle 客户端
      • 使用脚本
        • 概述
        • 预处理器脚本
        • 后处理器脚本
        • 公共脚本
        • Postman 脚本参考
        • 调用其他编程语言
        • 使用 JS 库
        • 可视化响应
        • 脚本示例
          • 断言脚本
          • 使用变量
          • 修改请求
          • 其他示例
    • API 调试
      • AI Agent Debugger
      • A2A 调试器
  • 设计 API
    • 概述
    • 创建新的 API 项目
    • 端点基础
    • API 设计指南
    • 模块
    • 配置多个请求主体示例
    • 组件
    • 通用字段
    • 全局参数
    • 端点变更历史
    • 评论
    • 批量端点管理
    • 自定义协议 API
    • Spec-first 模式(Beta)
    • 安全方案
      • 概述
      • 创建安全方案
      • 使用安全方案
      • 在线文档中的安全方案
    • 高级功能
      • 自定义端点字段
      • 关联的测试场景
      • 端点状态
      • 参数列表的外观
      • 端点唯一标识
    • Schemas
      • 概述
      • 创建新 Schema
      • 构建 Schema
      • 从 JSON 等生成 Schema
      • oneOf, allOf, anyOf
      • 使用 Discriminator
  • Apidog Europe
    • Apidog Europe
  • API 测试
    • 概述
    • 测试场景
      • 创建测试场景
      • 在请求之间传递数据
      • 流程控制条件
      • 从端点和端点用例同步数据
      • 从其他项目导入端点和端点用例
      • 导出测试场景
    • 测试报告
      • 测试报告
    • 运行测试场景
      • 运行测试场景
      • 批量运行测试场景
      • 数据驱动测试
      • 共享测试数据
      • 定时任务
      • 管理来自其他项目的 API 运行环境
    • 测试套件
      • 概述
      • 创建测试套件
      • 编排测试套件
      • 本地运行测试套件
      • 通过 CLI 运行测试套件
      • 定时任务
    • 测试 API
      • 集成测试
      • 性能测试
      • 端到端测试
      • 回归测试
      • 契约测试
    • Apidog CLI
      • 概述
      • 安装和运行 Apidog CLI
      • Apidog CLI 选项
    • CI/CD
      • 概述
      • 与 Github Actions 集成
      • 与 Gitlab 集成
      • 与 Jenkins 集成
      • 通过 Git Commit 触发测试
  • 发布 API 文档
    • 概述
    • 支持的 API 技术
    • 快速分享
    • 查看 API 文档
    • Markdown 文档
    • 发布文档站点
    • 自定义登录页面
    • 自定义布局
    • 自定义 CSS、JavaScript、HTML
    • 自定义域名
    • AI 功能
    • SEO 设置
    • 高级设置
      • 文档搜索
      • CORS 代理
      • 集成 Google Analytics
      • 文件夹树设置
      • 可见性设置
      • 在文档 URL 中嵌入值
    • API 版本
      • 概述
      • 创建 API 版本
      • 发布 API 版本
      • 共享带有 API 版本的端点
  • 分支
    • 概述
    • 创建 Sprint 分支
    • 在分支中测试 API
    • 在分支中设计 API
    • 合并 Sprint 分支
    • 管理 Sprint 分支
    • AI Branch(Beta)
  • AI 功能
    • 概述
    • 启用 AI 功能
    • 生成测试用例
    • 使用 AI 修改 Schema
    • 端点合规性检查
    • API 文档完整性检查
    • AI 驱动的字段命名
    • 常见问题
  • Apidog MCP 服务器
    • 概述
    • 将 Apidog 项目连接到 AI
    • 将已发布的文档连接到 AI
    • 将 OpenAPI 文件连接到 AI
  • 最佳实践
    • 处理 API 签名
    • 访问受 OAuth 2.0 保护的 API
    • 协作工作流
    • 管理身份验证状态
  • 离线空间
    • 概述
  • 管理
    • 管理项目
      • 管理项目
      • 通知设置
      • 管理项目成员
      • 项目资源
        • 数据库连接
        • Git 连接
    • 管理团队
      • 管理团队
      • 管理团队成员
      • 团队活动
      • 团队角色与权限
      • 团队资源
        • General Runner
        • 团队变量
        • 请求代理 Agent
      • 实时协作
        • 团队协作
    • 入门检查清单
      • 基本概念
      • 入门指南
    • 管理组织
      • 管理组织
      • 组织角色与权限
      • 套餐管理
        • 组织中的账单管理员
      • 单点登录 (SSO)
        • SSO 概述
        • 配置 Microsoft Entra ID
        • 配置 Okta
        • 为组织配置 SSO
        • 管理用户账户
        • 将组映射到团队
      • SCIM 配置
        • SCIM 预配简介
        • Microsoft Entra ID
        • Okta
      • 组织资源
        • 自托管 Runner
  • 计费
    • 概述
    • 积分
    • 升级您的套餐
    • 替代支付方式
    • 管理订阅
    • 将付费团队移入组织
  • 附加组件
    • API Hub
    • Apidog Intellij IDEA 插件
    • 浏览器扩展
      • Chrome
      • Microsoft Edge
    • 请求代理
      • Web 中的请求代理
      • 共享文档中的请求代理
      • 客户端中的请求代理
  • 数据与安全
    • 数据存储和安全
    • 用户数据隐私与安全
    • 请求路由与数据安全
  • 参考
    • API 设计优先方法
    • Apidog OpenAPI 规范扩展
    • JSONPath
    • XPath
    • 正则表达式
    • JSON Schema
    • CSV 文件格式
    • 安装 Java 环境
    • Runner 部署环境
    • Apidog Markdown 语法
    • Apidog Swagger 扩展
      • 概述
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Apidog JSON Schema 扩展
      • 概述
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • 支持中心
  1. 发布 API 文档

快速分享

高效的 API 协作需要无缝的文档共享。快速分享通过提供即时的在线文档链接,消除了来回传递 Word 或 PDF 文件的低效做法。此功能支持团队之间快速沟通,让你能够与协作者分享特定 API 端点,同时保持对访问权限、可见性和过期时间的控制。

前提条件#

在创建快速分享之前,请确保你具备:
拥有可访问项目的 Apidog 账号
要分享的 API 端点或文档
(可选)如果你希望阅读者测试端点,请配置环境

创建快速分享#

切换到左侧边栏中的 发布文档 模块。
CleanShot 2025-12-29 at 17.18.46@2x.png
点击 +New 创建新的快速分享。一个项目支持多个快速分享,可分发给不同的协作者。所有团队成员都可以查看团队中任何人创建的快速分享。
image.png

配置选项#

在新建分享对话框中,你可以自定义以下选项:
标题:此分享的名称,仅在 Apidog 团队内部可见,用于内部识别,不会显示在共享文档中。
环境:选择在线文档中可用的环境。默认情况下,不会选择任何环境。你可以选择多个环境。所选环境将在文档中对阅读者可见,并且在使用“Try it out”时可用于发送请求。
云端模拟环境
如果你在创建文档时选择云端模拟环境,则会为阅读者提供一个简单的沙盒环境来测试 API,而不会影响生产系统。
文档内容:文档包含两个可选组件:Base URL 和请求示例。你可以选择是否在文档中显示它们。
Base URL:这是环境中设置的基础 URL。如果选中,文档中的每个接口都会显示完整 URL;如果未选中,文档中的 URL 将以“/”开头。
所有者:显示此 API 文档的所有者。
请求示例:是否显示调用请求的示例代码。详情请参阅请求示例。
在端点描述上方显示“Last Modified”时间。
在文档末尾显示“Last Modified”时间。
允许“Export”、“Clone”数据:是否允许阅读者以 OAS/Markdown/HTML/Apidog 格式导出和克隆数据。
分享范围:选择此分享中要包含哪些 API 端点和 Markdown。你可以按目录或筛选器选择,并按标签排除。你也可以选择分享整个文件夹。
安全:你可以设置访问此文档是否需要密码,以及此文档的过期时间。如果未选择过期时间,则永不过期。
显示 API 字段:你可以设置这些字段是否显示在文档中。包括:所有者、更新时间、OperationId、原始链接、需要授权。
语言:此处的语言设置会影响文档中的功能性固定文本,例如“Query Params”“Request samples”等,但不会影响 API 文档内容中编写的文本。
CORS 代理:你可以部署并配置 CORS 代理服务器,以处理 API 文档上的端点请求。了解更多。
高级设置:配置隐藏“Try it out”按钮和隐藏“Powered by Apidog”等选项。

请求示例#

创建分享时,你可以选择是否显示请求代码示例。
如何自定义请求示例:
1.
在 设置 → 功能设置 → 端点功能设置 → 端点字段 中,启用请求示例字段
2.
在 端点 → 编辑 中,请求示例模块会出现在末尾
3.
点击 自定义请求代码示例,以你偏好的语言添加示例
CleanShot 2025-12-29 at 17.21.25@2x.png

分享整个文件夹#

快速分享支持 Share entire folder,非常适合在分享后仍会继续添加或移除文档的场景。启用后,协作者将自动访问该文件夹中的所有文档,而无需你为每个新文档调整分享设置。
在 Scope to Share 部分,选择 Manual Selection 即可看到 Share entire folder 选项。启用后,协作者将自动访问该文件夹中的所有文档。
sharing-03.png

CORS 代理配置#

与外部用户共享 API 文档时,他们在浏览器中直接测试端点时可能会遇到跨源资源共享(CORS)问题。CORS 代理通过指定的代理代理转发请求来解决此问题,从而绕过浏览器 CORS 限制,并实现顺畅的 API 测试。
要配置 CORS 代理,请在创建新的共享文档时点击设置选项。默认情况下,Apidog 提供 Cloud Agent 来管理所有共享文档中的端点请求。
image.png

CORS 代理选项#

选择最适合你需求的 CORS 代理选项:
image.png
云代理:使用 Apidog 的 Cloud Agent 处理端点请求。注意:Cloud Agent 无法访问内部网络上的端点
浏览器扩展:使用安装在用户浏览器中的浏览器扩展。未安装扩展的用户在发起请求前会被提示安装
无代理:请求直接从用户浏览器发送。请确保你的端点服务器已正确配置以处理 CORS
自托管请求代理代理:使用部署在你基础设施内的 Self-hosted Request Proxy Agent 来处理端点请求
Modified at 2026-06-09 08:55:47
Previous
支持的 API 技术
Next
查看 API 文档
Built with