AEM の GraphQL エンドポイントの管理

エンドポイントは、AEM 用 GraphQL へのアクセスに使用するパスです。このパスを使用すると、以下が可能になります。

  • GraphQL スキーマへのアクセス
  • GraphQL クエリの送信
  • （GraphQL クエリに対する）応答の受信

AEM には次の 2 種類のエンドポイントがあります。

  • グローバル
    • すべてのサイトで使用できます。
    • このエンドポイントは、（設定ブラウザーで定義された）すべての Sites 設定のすべてのコンテンツフラグメントモデルを使用できます。
    • Sites 設定間で共有する必要があるコンテンツフラグメントモデルがある場合は、それらをグローバル Sites 設定の下に作成する必要があります。
  • Sites 設定：
    • 設定ブラウザーで定義されている Sites 設定に対応します。
    • 指定したサイト／プロジェクトに固有です。
    • Sites 設定固有のエンドポイントは、その特定の Sites 設定のコンテンツフラグメントモデルと、グローバル Sites 設定のコンテンツフラグメントモデルを使用します。
注意

コンテンツフラグメントエディターを使用すると、Sites 設定のコンテンツフラグメントから別の Sites 設定のコンテンツフラグメントを（ポリシーを介して）参照できます。

この場合、Sites 設定固有のエンドポイントを使用してすべてのコンテンツを取得できるわけではありません。

コンテンツ作成者がこのシナリオを制御する必要があります。例えば、共有コンテンツフラグメントモデルをグローバルサイト設定の下に配置すると便利です。

AEM グローバルエンドポイント用 GraphQL のリポジトリーパスは次のとおりです。

/content/cq:graphql/global/endpoint

アプリは、リクエスト URL で次のパスを使用できます。

/content/_cq_graphql/global/endpoint.json

AEM 用 GraphQL のエンドポイントを有効にするには、次の操作が必要です。

GraphQL エンドポイントの有効化

GraphQL エンドポイントを有効にするには、まず適切な設定が必要です。「コンテンツフラグメント - 設定ブラウザー 」を参照してください。

注意

コンテンツフラグメントモデルの使用が有効になっていない場合、「作成」オプションは使用できません。

対応するエンドポイントを有効にするには、以下を行います。

  1. ツール／一般 に移動し、「GraphQL」を選択します。

  2. 「作成」を選択します。

  3. 新しい GraphQL エンドポイントを作成​ダイアログが開きます。以下を指定します。

    • 名前：エンドポイントの名前。任意のテキストを入力できます。
    • 使用する GraphQL スキーマの提供元： ドロップダウンを使用して、必要なサイト／プロジェクトを選択します。
    メモ

    ダイアログには次の警告が表示されます。

    • 慎重に管理しない場合、GraphQL エンドポイントによりデータのセキュリティとパフォーマンスで問題が発生する可能性があります。エンドポイントを作成した後で、適切な権限を設定するようにしてください。

  4. 「作成」で確定します。

  5. 「次の手順」ダイアログには、セキュリティコンソールへの直接リンクが表示されるので、新しく作成したエンドポイントに適切な権限が付与されているか確認できます。

    注意

    エンドポイントは、すべてのユーザーがアクセスできます。そのため、GraphQL クエリがサーバーに大きな負荷をかける可能性があるので、特にパブリッシュインスタンスでは、セキュリティ上の問題が発生するおそれがあります。

    使用例に適した ACL をエンドポイントに設定できます。

GraphQL エンドポイントの公開

新しいエンドポイントを選択し、「 公開」を選択して、すべての環境で完全に使用できるようにします。

注意

エンドポイントは、すべてのユーザーがアクセスできます。

GraphQL クエリがサーバーに大きな負荷をかける可能性があるので、パブリッシュインスタンスでは、セキュリティ上の問題が発生する恐れがあります。

ユースケースに適した ACL をエンドポイントにセットアップする必要があります。

このページ