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 文档
  • 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 文档创建一个永久且可完全自定义的主页——这不同于 Quick Share 功能,后者是为临时协作而设计的。Quick Share 会生成可分享链接,用于快速进行内部和外部沟通;而 Publish Docs Sites 提供全面的自定义选项,包括自定义域名、品牌化设计、导航控制和高级功能。这使其非常适合创建专业的、面向公众的 API 文档,以展现你的品牌形象。

前提条件#

在发布文档站点之前,请确保你已具备:
一个 Apidog 账号,且其中的项目包含 API 文档
该项目的管理员权限
(可选)如果你计划使用品牌化 URL,则需要一个自定义域名

初步配置#

发布你的文档站点#

要发布你的文档站点,请导航到 Publish Docs 模块并点击默认主站点,然后点击 Publish 按钮。
图片.png

文档站点可见性设置#

版本要求
Apidog 版本必须 ≥ 2.7.15 才能访问这些可见性功能。
点击 Publish 按钮后,你可以根据安全性和访问需求控制已发布文档站点的可见性。点击 Publish right now 按钮,即可使用你选择的可见性设置让站点上线。
图片.png
公开
你的文档站点将对所有互联网用户开放。你也可以选择将 API 文档发布到 API Hub,这是一个由 Apidog 运营的平台,可帮助用户发现和探索 API。
密码保护
IP 白名单
邮箱白名单
自定义登录页面

发布范围#

默认情况下,发布文档的范围设置为所有Shared资源。你可以在APIs中配置此项。更多详情,请参阅可见性设置。

高级配置#

Try It#

你可以为文档页面启用 Try It 功能,以便用户可以直接在文档页面中发起 API 请求。
图片.png

发布版本#

你可以创建并发布 API 文档的多个版本。了解有关发布 API 版本的更多信息。
API 文档的发布设置.jpg
相关资源
文档用户如何在共享文档中修改 Base URL?
如何在 Apidog 在线文档中共享头部(例如 Token)?

域名设置#

Apidog 提供的域名:你的文档将拥有一个默认的 Apidog 子域名,例如 https://vhh2uhkjv7.apidog.io。你也可以手动修改它。所有 Apidog 文档都使用 apidog.io 域名。
自定义域名:你可以将 Apidog 文档绑定到你自己的域名。了解有关自定义域名的更多信息。
API 文档的域名设置.jpg

视觉自定义#

你可以自定义 API 文档的外观和布局。
图片.png
你可以在这里实时预览文档,并在对结果满意后保存。
Apidog-01.gif
外观
布局与导航
自定义落地页
自定义 CSS、JavaScript 和 HTML
在外观设置中,你可以为 API 文档配置各种基础选项,包括 Title、Logo 和 Favicon。
图片.png
在 Display content 下,你可以自定义 API 文档中要显示的字段,包括:Base URL、Maintainer 和 Last Modified Time。
图片.png

SEO 设置#

设置描述
全局元数据配置整个站点的默认元数据。
Robots 文件robots.txt 文件会指示搜索引擎应抓取哪些页面,并在搜索结果中显示哪些页面。
Sitemap 文件sitemap.xml 文件会为搜索引擎提供你站点上所有页面的完整列表,以便更好地建立索引。
文档重定向规则当 URL 发生变化时,将用户重定向到正确的文档页面,防止出现失效链接。
URL 与 Slug 规则定义文档页面的 URL 结构和 slug 格式。

高级设置#

功能描述
文档搜索与 Algolia 集成,为你发布的 API 文档提供增强搜索能力。Ask AI 功能可直接在文档搜索中解锁由 AI 驱动的对话式问答。
CORS Proxy指定 CORS 代理,以防止因浏览器安全限制而可能出现的跨源问题。
Google Analytics启用与 Google Analytics 的集成,用于跟踪和分析文档站点的流量。
发布到 API Hub将你的文档发布到 API Hub,这是一个用于分享和发现 API 的开放平台。
描述设置当项目发布到 API Hub 时将在 API Hub 上显示的描述。
允许“导出”、“克隆”数据允许用户从主分支导出或克隆文档数据。

发布多个文档站点#

要在同一项目内通过不同渠道发布文档,你可以在发布期间创建额外的文档站点。为了便于管理,你可以为每个新站点复制主站点的配置。每个子站点也可以拥有唯一的自定义域名。
发布文档站点介绍-05.png
只有子站点允许你设置已发布文档的可见范围,使你可以选择哪些资源可公开访问。
发布文档站点介绍-06.png
Modified at 2026-06-09 08:55:47
Previous
Markdown 文档
Next
自定义登录页面
Built with