管理实时文档 | Qlik Cloud帮助
跳到主要内容 跳到补充内容

管理实时文档

上次更新日期:2026/10/20

启用实时文档

为了与不在您团队中的人员共享您的 API 文档,您需要启用 Live Documentation 功能。

在启用之前,它仅对拥有 API 定义访问权限的用户以预览形式可见。

  1. 通过点击 编辑 > 打开 API 设置,转到您 API 的设置页面。
  2. 将已启用按钮从关切换为开,并输入 URL。
    实时文档配置。
  3. 选择可见性。如果选择受密码保护,请在相应字段中输入密码。
  4. 点击保存以启用您的实时文档。

您的实时文档现已可用。您可以点击 打开 以在新标签页中将其打开。

禁用实时文档

停用您的文档,并选择是否保留其子域名。

  1. 打开您的 API 并转到 Open API 设置。
  2. 将已启用按钮从开切换为关。
  3. 如果您想要释放文档子域,请清除保留实时 API 文档子域复选框。
    默认情况下,API 契约会保存您在启用实时文档时定义的子域。这样,如果您以后再次启用它,就可以保留相同的 URL。如果您想将此子域名用于其他 API,则首先需要将其释放。
    实时文档配置。
  4. 单击保存。
您的实时文档已禁用。如果您保留了该子域,您可以随时重新启用它。否则,该子域名可能会被其他 API 使用,如果您想再次启用此文档, 则需要输入一个子域名。

本页面有帮助吗?

如果您发现此页面或其内容有任何问题 – 打字错误、遗漏步骤或技术错误 – 请告诉我们!