API リクエストの作成 - ヘッドレス設定 accessing-delivering-content-fragments
コンテンツフラグメントコンテンツと AEM Assets REST API のヘッドレス配信に GraphQL API を使用して、コンテンツフラグメントを管理する方法を説明します。
GraphQL API と Assets REST API とは what-are-the-apis
コンテンツフラグメントをいくつか作成したので、AEM の API を使用してヘッドレスで配信できます。
- GraphQL API を使用すると、コンテンツフラグメントにアクセスして配信するリクエストを作成できます。この API は、コンテンツフラグメントコンテンツのクエリと使用に最も堅牢な機能セットを提供します。
- API を使用するには、エンドポイントを AEM で定義して有効にし、必要に応じて GraphiQL インターフェイスをインストールします。
- 様々な 構造化コンテンツ配信および管理用のAEM API をコンテンツフラグメントと共に使用できます。
このガイドの残りの部分では、GraphQL へのアクセスとコンテンツフラグメントの配信について説明します。
GraphQL エンドポイントの有効化 enable-graphql-endpoint
GraphQL API を使用する前に、GraphQL エンドポイントを作成する必要があります。
詳しくは、AEMのGraphQL エンドポイントの管理 を参照してください。
GraphQL と GraphiQL を使用したクエリコンテンツ
情報アーキテクトは、チャネルエンドポイントがコンテンツを配信するためのクエリを設計します。これらのクエリは、エンドポイントごと、モデルごとに 1 回だけ検討してください。この入門ガイドでは、作成する必要があるのは 1 つだけです。
GraphiQL は IDE であり、AEM 環境に含まれています。エンドポイントを設定した後、アクセス可能になり表示されます。
詳しくは、GraphiQL IDE の使用 を参照してください。
GraphQL を使用すると、特定のデータセットや個々のデータオブジェクトをターゲットにするだけでなく、オブジェクトの特定の要素、ネストされた結果を配信したり、クエリ変数のサポートを提供したりできる構造化クエリが可能になります。
GraphQL では、反復的な API リクエストと過剰な配信を回避でき、代わりに単一の API クエリへの応答としてレンダリングに必要なものを正確に一括配信できます。結果の JSON を使用して、他のサイトやアプリにデータを配信できます。
次の手順 next-steps
これで作業は完了です。AEM のヘッドレスコンテンツ管理に関する基本的な内容を説明しました。利用可能な機能の包括的な理解を深めるためのリソースは他にもたくさんあります。
- コンテンツフラグメント - コンテンツフラグメントの作成と管理に関する詳細
- AEM Assets HTTP API でサポートされるコンテンツフラグメント - CRUD 操作(作成、読み取り、更新、削除)を介して HTTP API 経由で直接 AEM コンテンツにアクセスする方法の詳細
- GraphQL API - コンテンツフラグメントをヘッドレスで配信する方法の詳細