跳到主要内容

发布文档站

发布文档站与在线分享不同，在线分享主要提供分享链接给内外部的合作伙伴，是一种临时性的沟通。


发布文档站支持设置自定义域名、页面外观、页面导航等等。当你需要把你的接口文档，放在你的官网，面向所有互联网上的读者时，就需要使用「发布文档站」了。

发布你的文档站​

点击默认站点卡片，点击 “发布” 按钮。

发布文档站

文档站可见性设置​

Apifox 版本需 ≥ 2.6.39

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

文档站可见性设置

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

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

    密码保护

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

    IP 白名单

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

    Email 白名单

发布范围​

发布文档的默认范围是设置为「共享」的资源文件，需要在 “接口管理” 中设置，详情请看文档可见性设置。

发布多版本的文档站​

当需要对外发布项目中接口的多个版本时，可以使用「API 版本」功能，详情请查看 API 版本管理。

发布多个文档站​

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

发布文档站

仅子站点支持设置公开文档的范围，你可以选择哪些资源对外公开显示。