コンテンツフラグメントとヘッドレスクイック開始ガイドへのアクセスと配信 accessing-delivering-content-fragments
AEM Assets REST API を使用して、コンテンツフラグメントと、コンテンツフラグメントコンテンツのヘッドレス配信用の GraphQL API を管理する方法について説明します。
GraphQL API と Assets REST API とは what-are-the-apis
コンテンツフラグメントはいくつか作成したので、AEM API を使用してそれらをヘッドレスで配信できます。
- GraphQL API を使用すると、コンテンツフラグメントにアクセスして配信するリクエストを作成できます。
- これを使用するには、AEM で エンドポイントを定義して有効にする必要があり、必要に応じて GraphiQL インターフェイスをインストールする必要があります。
- アセット REST API を使用すると、コンテンツフラグメント(およびその他のアセット)を作成および変更できます。
このガイドの残りの部分では、GraphQL へのアクセスとコンテンツフラグメントの配信について説明します。
GraphQL を使用したコンテンツフラグメントの配信方法 how-to-deliver-a-content-fragment
情報アーキテクトは、チャネルエンドポイントがコンテンツを配信するためのクエリを設計します。これらのクエリは、エンドポイントごと、モデルごとに 1 回だけ考慮してください。この入門ガイドでは、1 つだけ作成します。
-
AEM にログインし、GraphiQL インターフェイスにアクセスします。
- 例:
http://<host>:<port>/aem/graphiql.html
- 例:
-
GraphiQL は、GraphQL のブラウザー内のクエリエディターです。クエリーを作成して、コンテンツフラグメントを取得し、それらを JSON としてヘッドレスに配信できます。
- 左パネルで、クエリを作成できます。
- 右側のパネルに結果が表示されます。
- クエリエディターは、コード補完機能とホットキーを備えており、クエリを簡単に実行できます。
-
作成したモデルが
person
でfirstName
、lastName
、position
の各フィールドを持つ場合は、単純なクエリーを構築して、コンテンツフラグメントのコンテンツを取得できます。code language-text query { personList { items { _path firstName lastName position } } }
-
左パネルにクエリを入力します。
-
「クエリを実行」アイコン(右矢印)をクリックするか
Ctrl-Enter
ホットキーを使用すると、結果が JSON として右側のパネルに表示されます。
-
以下をクリックします。
- ページの右上にある ドキュメント をクリックすると、文脈依存ドキュメントが表示され、独自のモデルに適合したクエリを構築するのにに役立ちます。
- 上部のツールバーにある 履歴 をクリックすると、以前のクエリが表示されます。
- 「名前を付けて保存」と「保存」をクリックしてクエリを保存します。保存後は、永続クエリ パネルと「パブリッシュ」でクエリを一覧表示して取得できます。.
GraphQL を使用すると、特定のデータセットや個々のデータオブジェクトをターゲットにするだけでなく、オブジェクトの特定の要素、ネストされた結果を配信したり、クエリ変数のサポートを提供したりできる構造化クエリが可能になります。
GraphQLは、繰り返しの API リクエストや過剰な配信を避けることができます。代わりに、単一の API クエリへの応答としてレンダリングに必要なものを正確に一括配信できます。結果の JSON を使用して、他のサイトやアプリにデータを配信できます。
次の手順 next-steps
これで作業は完了です。AEM のヘッドレスコンテンツ管理に関する基本的な内容を説明しました。利用可能な機能の包括的な理解を深めるためのリソースは他にもたくさんあります。
- 設定ブラウザー - AEM 設定ブラウザーの詳細
- コンテンツフラグメント - コンテンツフラグメントの作成と管理に関する詳細
- GraphiQL IDE - GraphiQL IDE の使用の詳細
- 永続クエリ - 永続クエリの詳細
- AEM Assets HTTP API でサポートされるコンテンツフラグメント - CRUD 操作(作成、読み取り、更新、削除)を介して HTTP API 経由で直接 AEM コンテンツにアクセスする方法の詳細
- GraphQL API - コンテンツフラグメントをヘッドレスで配信する方法の詳細