コンテンツフラグメントコンテンツと AEM Assets REST API のヘッドレス配信に GraphQL API を使用して、コンテンツフラグメントを管理する方法を説明します。
コンテンツフラグメントはいくつか作成したので、AEM API を使用してそれらをヘッドレスで配信できます。
このガイドの残りの部分では、GraphQL へのアクセスとコンテンツフラグメントの配信について説明します。
GraphQL API を使用する前に、GraphQL エンドポイントを作成する必要があります。
ツール/一般 に移動し、「GraphQL」を選択します。
「作成」を選択します。
新しい GraphQL エンドポイントを作成ダイアログが開きます。以下を指定します。
「作成」で確定します。
コンソールで、前に作成した設定に基づいて、パスが表示されます。これは、GraphQL クエリの実行に使用されるパスです。
/content/cq:graphql/<configuration-name>/endpoint
GraphQL エンドポイントの有効化について詳しくは、こちらを参照してください。
情報アーキテクトは、コンテンツを配信するために、チャネルエンドポイント用のクエリを設計する必要があります。一般に、これらのクエリは、モデルやエンドポイントごとに 1 回だけ作成する必要があります。この「はじめる前に」ガイドの目的上、1 つだけ作成します。
GraphiQL は IDE であり、AEM 環境に含まれています。エンドポイントを設定した後、アクセス可能になり表示されます。
AEM as a Cloud Service にログインし、GraphiQL インターフェイスにアクセスします。
クエリエディターには、次のいずれかの方法でアクセスできます。
http://localhost:4502/aem/graphiql.html
)GraphiQL は、GraphQL のブラウザー内のクエリエディターです。クエリを作成して、コンテンツフラグメントを取得し、それらを JSON としてヘッドレスに配信できます。
作成したモデルが person
で firstName
、lastName
、position
の各フィールドを持つ場合は、単純なクエリを構築して、コンテンツフラグメントのコンテンツを取得できます。
query
{
personList {
items {
_path
firstName
lastName
position
}
}
}
左側のパネルにクエリを入力します。
「クエリを実行」ボタンをクリックするか Ctrl-Enter
ホットキーを使用すると、結果が JSON として右側のパネルに表示されます。
ページの右上にあるドキュメントリンクをクリックすると、文脈依存ドキュメントが表示され、独自のモデルに適合するクエリの構築に役立ちます。
GraphQL を使用すると、特定のデータセットや個々のデータオブジェクトだけでなく、オブジェクトの特定の要素、ネストされた結果、クエリ変数のオファーサポートなどをターゲットできる構造化クエリが可能です。
GraphQL では、反復的な API リクエストと過剰な配信を回避でき、代わりに単一の API クエリに対するレンダリングに必要なものを一括配信できます。結果の JSON を使用して、他のサイトやアプリにデータを配信できます。
これで作業は完了です。AEM のヘッドレスコンテンツ管理に関する基本的な内容を説明しました。もちろん、利用可能な機能の包括的な理解を深めるためのリソースは他にもたくさんあります。