发布文档站
发布文档站与在线分享不同,在线分享主要提供分享链接给内外部的合作伙伴,是一种临时性的沟通。
发布文档站支持设置自定义域名、页面外观、页面导航等等。当你需要把你的接口文档,放在你的官网,面向所有互联网上的读者时,就需要使用「发布文档站」了。
发布你的文档站
点击默认站点卡片,点击 “发布” 按钮。
你可以选择将你的文档发布在 API Hub 上。这是一个由 Apifox 运营的,专门用于分享和探索 API 的开放平台。
如果你想给你的文档设置密码,只需选择 “密码保护” 选项,然后输入你想要的密码即可,点击 “立即发布” 按钮即可发布你的文档站。
你可以在下图中设置运行环境,方便读者进行调试接口时,使用你提供的环境。
发布范围
发布文档的默认范围是设置为「共享」的资源文件,需要在 “接口管理” 中设置,详情请看文档可见性设置。
发布多版本的文档站
当需要对外发布项目中接口的多个版本时,可以使用「API 版本」功能,详情请查看 API 版本管理。
发布多个文档站
当你希望将文档发布到不同渠道,同时又希望在同一项目中进行维护时,可以在发布文档时新建文档站点。为了方便管理,你可以复制主站点的配置项来创建新站点。每个子站点都可以设置不同的自定义域名。
仅子站点支持设置公开文档的范围,你可以选择哪些资源对外公开显示。