发布文档站

发布文档站和使用 “快捷分享” 功能是两个不同的概念。“快捷分享” 生成的链接主要用于内部和外部伙伴之间的临时分享，不适合长期使用。

相比之下，“发布文档站” 功能提供了更丰富的自定义选项。你可以自定义域名、页面外观、页面导航等。当你需要把你的接口文档，放在你的官网，面向所有互联网上的读者时，这个功能是最佳选择。

点击默认主站点，然后点击 “发布” 按钮。

按照下图所示设置环境，这样可以帮助用户更方便地调试你提供的 API。

文档站可见性设置

Apifox 版本要求 ≥ 2.6.39

可以根据你的需要，设置文档站的可见性。点击 “立即发布” 按钮即可发布你的文档站。

可选的可见性设置：

公开发布： 意味着所有互联网上的用户，都可以访问你的文档站。你也可以选择将你的文档发布在 API Hub 上，让更多的用户发现你的文档站。API Hub 是一个由 Apifox 运营的，专门用于分享和探索 API 的开放平台。

密码保护： 如果你想给你的文档设置密码，只需选择 “密码保护” 选项，然后输入你想要的密码或者随机生成的密码即可。

IP 白名单： 只有你设置的 “单个 IP 地址和 IP 段” 才可以访问你的文档站。

Email 白名单： 只有你设置的 “Email” 名单，才可以通过邮箱验证码的方式，访问你的文档站。邮箱白名单支持通配符，方便你对企业邮箱地址的设置。

发布范围

默认情况下，文档发布范围包括所有 “已共享” 的资源。你可以在 “接口管理” 中配置这个选项。详情请参考文档可见性设置。

发布多版本的文档站

要发布多个 API 版本的文档，使用 “API 版本” 功能。详情请查看 API 版本。

发布多个文档站

当你希望将文档发布到不同渠道，同时又希望在同一项目中进行维护时，可以在发布文档时新建文档站点。为了方便管理，你可以复制主站点的配置项来创建新站点。每个子站点都可以设置不同的自定义域名。

只有子站点允许设置发布文档的可见范围，让你可以选择哪些资源可以公开访问。

永久链接

Apifox 提供的域名：你的文档会有一个默认的 Apifox 子域名，比如 ykr5x1s46r.apifox.cn，你可以手动修改它。所有 Apifox 文档都使用 apifox.cn 域名。

自定义域名：你可以把 Apifox 文档绑定到自己的域名。了解更多关于自定义域名的信息。

文档重定向规则：你可以设置重定向规则，在 URL 变更时自动把用户引导到正确的文档，避免链接失效，保证用户体验。

其他设置

文档搜索：已发布的 API 文档默认包含内置搜索功能，Apifox 还提供了 Algolia 集成来增强搜索能力。了解更多关于文档搜索的信息。

发布到 API Hub：你可以选择把文档发布到 API Hub，这是 Apifox 运营的一个专门用于分享和探索 API 的开放平台。

允许导出、克隆数据：你可以导出主分支中已发布的文档数据。

个性化设置

在 “个性化设置” 中，你可以设置 API 文档的各种基本选项，包括：

标题

Logo

网站图标

描述

主题色

语言

明/暗模式

文档内容显示

在 “个性化设置” 中，你还可以自定义在 API 文档中显示哪些字段，包括：

前置 URL

示例代码

责任人

接口文档最后修改时间

OperationId

高级设置

你可以选择隐藏一些不想让用户看到的信息，比如：

隐藏 "Powered by Apifox"

展示 "调试" 按钮

允许 "导出"、"克隆" 数据

文档自定义布局

你可以轻松自定义页面布局。了解更多关于自定义布局的信息。

发布文档站