存取及傳遞內容片段Headless快速入門手冊

瞭解如何使用AEM Assets REST API來管理內容片段,以及如何使用GraphQL API無周邊式傳送內容片段內容。

什麼是 GraphQL 和 Assets REST API?

現在您已經建立一些內容片段,您可以使用 AEM 的 API Headless 傳遞內容片段。

本指南的其餘部分著重在 GraphQL 存取和內容片段傳遞。

如何使用GraphQL傳遞內容片段

資訊架構師必須為其通道端點設計查詢才能傳送內容。 每個模型的每個端點只需考慮一次這些查詢。 出於本快速入門指南的目的,您只需要建立一個。

  1. 登入AEM並存取 GraphiQL介面

    • 例如:http://<host>:<port>/aem/graphiql.html
  2. GraphiQL 是 GraphQL 的瀏覽器內查詢編輯器。您可以使用它來建置查詢,以擷取內容片段,並以JSON格式輕鬆傳送。

    • 左側面板可讓您建置查詢。

    • 右側面板會顯示結果。

    • 查詢編輯器具有程式碼完成和快速鍵功能,可輕鬆執行查詢。

      GraphiQL 編輯器

  3. 假設您建立的模型名為 person,其中包含欄位 firstNamelastNameposition,您可以建立一個簡單的查詢來擷取內容片段的內容。

    query
    {
      personList {
        items {
          _path
          firstName
          lastName
          position
        }
      }
    }
    
  4. 在左側面板中輸入查詢。

  5. 按一下 執行查詢 (向右鍵)圖示或使用 Ctrl-Enter 快速鍵和結果會在右側面板中顯示為JSON。
    GraphiQL 結果

  6. 按一下:

    • 檔案 在頁面的右上方,顯示快顯檔案,協助您建立適合您自己模型的查詢。

    • 歷史記錄 頂端工具列以顯示先前的查詢。

    • 另存為儲存 以儲存查詢,之後您可從 持久查詢 面板和 發佈.

      GraphiQL 文件

GraphQL 支援結構化查詢,這些查詢不僅可以針對特定資料集或個別資料物件,還可以傳遞物件的特定元素、巢狀結果、支援查詢變數等等。

GraphQL可避免反複的API請求和過度傳送。 相反地,它允許作為對單一API查詢的回應,大量傳送精確呈現所需的內容。 產生的 JSON 可用於將資料傳遞到其他網站或應用程式。

後續步驟

就是這樣!您現在對 AEM Headless 內容管理有基本的了解。還有更多資源可供您深入研究以全面了解可用的功能。

本頁內容