管理即時文件 | Qlik Cloud 說明
跳到主要內容 跳至補充內容

管理即時文件

上次更新:2026/10/20

啟用即時文件

為了與不在您團隊中的人員共用您的 API 文件,您需要啟用 Live Documentation 功能。

在啟用之前,只有具備該 API 定義存取權限的使用者才能以預覽形式檢視。

  1. 按一下 編輯 > 開啟 API 設定,前往您 API 的設定頁面。
  2. 將 已啟用 按鈕從 關閉 切換至 開啟 並輸入 URL。
    即時文件設定。
  3. 選擇可見度。 如果您選取受密碼保護,請在對應的欄位中輸入密碼。
  4. 按一下儲存以啟用您的即時說明文件。

您的即時文件現已可供使用。您可以按一下 開啟 以在新分頁中開啟。

停用即時文件

停用您的說明文件,並選擇是否要保留其子網域。

  1. 開啟您的 API,並前往 開放 API 設定。
  2. 將 已啟用 按鈕從 開啟 切換為 關閉。
  3. 如果您要釋出說明文件子網域,請清除保留 Live API 說明文件子網域核取方塊。
    依預設,API 合約會儲存您在啟用即時文件時定義的子網域。這 可讓您在日後重新啟用時保留相同的 URL。如果您要將此子網域用於其他 API,您必須先將其釋放。
    即時文件設定。
  4. 按一下儲存。
您的即時文件已停用。如果您保留了子網域,您可以隨時 重新啟用。否則,該子網域可能會被其他 API 使用;若您想要再次啟用此說明文件,將需要輸入子網域。

此頁面是否對您有幫助?

若您發現此頁面或其內容有任何問題——錯字、遺漏步驟或技術錯誤——請告知我們!