コンテンツフラグメントへのアクセスとヘッドレス配信クイック開始ガイド

AEM Assets REST API を使用して、コンテンツフラグメントと、コンテンツフラグメントコンテンツのヘッドレス配信用の GraphQL API を管理する方法について説明します。

GraphQL API と Assets REST API とは何ですか

コンテンツフラグメントはいくつか作成したので、AEM API を使用してそれらをヘッドレスで配信できます。

  • GraphQL API を使用すると、コンテンツフラグメントにアクセスして配信するリクエストを作成できます。
  • アセット REST API を使用すると、コンテンツフラグメント(およびその他のアセット)を作成および変更できます。

このガイドの残りの部分では、GraphQL へのアクセスとコンテンツフラグメントの配信について説明します。

GraphQL を使用したコンテンツフラグメントの配信方法

情報アーキテクトは、コンテンツを配信するために、チャネルエンドポイント用のクエリを設計する必要があります。一般に、これらのクエリは、モデルやエンドポイントごとに 1 回だけ作成する必要があります。この「はじめる前に」ガイドの目的上、1 つだけ作成します。

  1. AEM as a Cloud Service にログインし、GraphiQL インターフェイスにアクセスします。

    • 例:https://<host>:<port>/content/graphiql.html
  2. GraphiQL は、GraphQL のブラウザー内のクエリエディターです。クエリを構築して、コンテンツフラグメントを取得し、それらを JSON としてヘッドレスに配信できます。

    • 左側のパネルでは、クエリを作成できます。
    • 右側のパネルに結果が表示されます。
    • クエリエディターは、コード補完機能とホットキーを備えており、クエリを簡単に実行できます。
      GraphiQL エディター
  3. 作成したモデルが personfirstNamelastNameposition の各フィールドを持つ場合は、単純なクエリを構築して、コンテンツフラグメントのコンテンツを取得できます。

    query 
    {
      personList {
        items {
          _path
          firstName
          lastName
          position
        }
      }
    }
    
  4. 左側のパネルにクエリを入力します。
    GraphiQL クエリ

  5. クエリを実行」ボタンをクリックするか Ctrl-Enter ホットキーを使用すると、結果が JSON として右側のパネルに表示されます。
    GraphiQL の結果

  6. ページの右上にある​ドキュメントリンクをクリックすると、文脈依存ドキュメントが表示され、独自のモデルに適合するクエリの構築に役立ちます。
    GraphiQL ドキュメント

GraphQL を使用すると、特定のデータセットや個々のデータオブジェクトだけでなく、オブジェクトの特定の要素、ネストされた結果、クエリ変数のオファーサポートなどをターゲットできる構造化クエリが可能です。

GraphQL では、反復的な API リクエストと過剰な配信を回避でき、代わりに単一の API クエリに対するレンダリングに必要なものを一括配信できます。結果の JSON を使用して、他のサイトやアプリにデータを配信できます。

次の手順

これで作業は完了です。AEM のヘッドレスコンテンツ管理に関する基本的な内容を説明しました。もちろん、利用可能な機能の包括的な理解を深めるためのリソースは他にもたくさんあります。

このページ