在 AEM 中管理 GraphQL 端點

上次更新: 2023-12-05

端點是用於存取 AEM GraphQL 的路徑。使用此路徑,您 (或您的應用程式) 可以:

  • 存取 GraphQL 結構描述,
  • 傳送您的 GraphQL 查詢,
  • 接收 (對您的 GraphQL 查詢) 的回應。

在 AEM 有兩種端點類型:

  • 全域
    • 可供所有網站使用。
    • 此端點可以使用來自所有 Sites 設定的所有內容片段模型 (在設定瀏覽器中定義)。
    • 如果內容片段模型應該在 Sites 設定之間共用,則應在全域 Sites 設定下建立該模型。
  • Sites 設定:
    • 對應至設定瀏覽器中定義的 Sites 設定。
    • 專屬於指定的網站/專案。
    • Sites 設定專屬端點將使用來自該特定 Sites 設定的內容片段模型以及來自全域 Sites 設定的內容片段模型。
注意

內容片段編輯器可以允許一個 Sites 設定的內容片段參考另一個 Sites 設定的內容片段 (透過原則)。

在這種情況下,並非所有內容都可以使用 Sites 設定專屬端點進行擷取。

內容作者應該控制這種情況;例如,考慮將共用的內容片段模型放在全域 Sites 設定下可能會有用。

AEM 全域端點的 GraphQL 存放庫路徑:

/content/cq:graphql/global/endpoint

為此,您的應用程式可以在要求 URL 中使用以下路徑:

/content/_cq_graphql/global/endpoint.json

若要啟用 AEM GraphQL 端點,您需要:

啟用 GraphQL 端點

若要啟用 GraphQL 端點,您首先需要有適當的設定。請參閱內容片段 - 設定瀏覽器

注意

如果尚未啟用使用內容片段模型,則​建立​選項將無法使用。

若要啟用對應的端點:

  1. 導覽至​工具一般,然後選取 GraphQL

  2. 選擇 建立

  3. 建立新的GraphQL端點 對話方塊開啟。 您可以在這裡指定:

    • 名稱:端點名稱,您可以輸入任何文字。
    • 使用由提供的GraphQL結構描述:使用下拉式清單來選取所需的網站/專案。
    注意

    對話框會顯示以下警告:

    • 如果未妥善管理,GraphQL 端點可能會導致資料安全性和效能問題。在建立端點後,請務必設定適當的權限。
  4. 使用​建立​確認。

  5. 後續步驟 對話方塊將提供安全性主控台的直接連結,因此您可以確保建立的端點具有合適的許可權。

    注意

    每個人都可以存取此端點。這可能帶來安全性問題,尤其是在發佈執行個體上,因為 GraphQL 查詢會給伺服器帶來沉重的負載。

    您可以在端點上設定適合您使用案例的 ACL。

發佈您的 GraphQL 端點

選取新端點並​發佈,使其在所有環境中完全可用。

注意

每個人都可以存取此端點。

這可能為發佈執行個體帶來安全性問題,因為 GraphQL 查詢會給伺服器帶來沉重的負載。

設定 適合您使用案例的ACL 在端點上。

本頁內容