发布文档站和使用 “快捷分享” 功能是两个不同的概念。“快捷分享” 生成的链接主要用于内部和外部伙伴之间的临时分享,不适合长期使用。相比之下,“发布文档站” 功能提供了更丰富的自定义选项。你可以自定义域名、页面外观、页面导航等。当你需要把你的接口文档,放在你的官网,面向所有互联网上的读者时,这个功能是最佳选择。发布文档站#
按照下图所示设置环境,这样可以帮助用户更方便地调试你提供的 API。文档站可见性设置#
可以根据你的需要,设置文档站的可见性。点击 “立即发布” 按钮即可发布你的文档站。1.
公开发布: 意味着所有互联网上的用户,都可以访问你的文档站。你也可以选择将你的文档发布在 API Hub 上,让更多的用户发现你的文档站。API Hub 是一个由 Apifox 运营的,专门用于分享和探索 API 的开放平台。 2.
密码保护: 如果你想给你的文档设置密码,只需选择 “密码保护” 选项,然后输入你想要的密码或者随机生成的密码即可。 3.
IP 白名单: 只有你设置的 “单个 IP 地址和 IP 段” 才可以访问你的文档站。 4.
Email 白名单: 只有你设置的 “Email” 名单,才可以通过邮箱验证码的方式,访问你的文档站。邮箱白名单支持通配符,方便你对企业邮箱地址的设置。 发布范围#
默认情况下,文档发布范围包括所有 “已共享” 的资源。你可以在 “接口管理” 中配置这个选项。详情请参考文档可见性设置。发布多版本的文档站#
要发布多个 API 版本的文档,使用 “API 版本” 功能。详情请查看 API 版本。