管理 Live Documentation | Qlik Cloud 說明
跳到主要內容 跳至補充內容

管理 Live Documentation

啟用 Live Documentation

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

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

  1. 前往 API 的 Settings 頁面,請按一下 Edit > Open API settings
  2. Enabled 按鈕從 Off 切換為 On,然後輸入 URL。
    Live Documentation 設定。
  3. 選擇可見性。如果您選取 Password protected, 請在對應的欄位中輸入密碼。
  4. 按一下 Save 以啟用您的 Live Documentation。

您的 Live Documentation 現在已可使用。您可以按一下 Open 在新索引標籤中開啟它。

停用 Live Documentation

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

  1. 開啟您的 API 並前往 Open API settings
  2. Enabled 按鈕從 On 切換為 Off
  3. 如果您想要釋放文件子網域,請清除 Retain Live API documentation subdomain 核取方塊。
    依預設,API Designer 會儲存您在啟用 Live Documentation 時定義的子網域。這可讓您在稍後再次啟用時保留相同的 URL。如果您想要將此子網域用於不同的 API,您首先需要釋放它。
    Live Documentation 設定。
  4. 按一下 Save
您的 Live Documentation 已停用。如果您保留了子網域,您可以隨時再次啟用它。如果沒有,該子網域可供其他 API 使用,如果您想要再次啟用此文件,則需要輸入子網域。

此頁面是否對您有幫助?

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