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

管理实时文档

启用实时文档

为了与团队外的人员共享您的 API 文档,您需要启用实时文档功能。

在启用之前,它只能作为预览供有权访问 API 定义的用户查看。

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

您的实时文档现已可用。您可以单击打开以在新选项卡中将其打开。

禁用实时文档

禁用您的文档并选择是否要保留其子域。

  1. 打开您的 API 并转到打开 API 设置
  2. 已启用按钮从切换为
  3. 如果要释放文档子域,请清除保留实时 API 文档子域复选框。
    默认情况下,API Designer 会保存您在启用实时文档时定义的子域。这允许您在以后再次启用它时保持相同的 URL。如果要将此子域用于不同的 API,首先需要释放它。
    实时文档配置。
  4. 单击保存
您的实时文档已禁用。如果您保留了子域,则可以随时再次启用它。如果没有,该子域可供另一个 API 使用,如果您想再次启用此文档,则需要输入一个子域。

本页面有帮助吗?

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