永続的な GraphQL クエリ

永続的なクエリは、Adobe Experience Manager（AEM）as a Cloud Service サーバーで作成および保存される GraphQL クエリです。永続的なクエリは、クライアントアプリケーションから GET リクエストでリクエストできます。GET リクエストの応答は、Dispatcher および CDN レイヤーでキャッシュできるので、最終的には、要求元のクライアントアプリケーションのパフォーマンスが向上します。これは、標準の GraphQL クエリとは異なります。標準クエリは、応答を簡単にはキャッシュできない POST リクエストを使用して実行されます。

この GraphiQL IDE は、以前にAEMで GraphQL クエリを開発、テスト、永続化できます。 実稼動環境への移行. カスタマイズが必要な場合（例えば、キャッシュをカスタマイズする場合）、API を使用できます。GraphQL クエリを永続化する方法で示される curl の例を参照してください。

永続的なクエリとエンドポイント

持続的なクエリでは、常に適切な Sites 設定に関連するエンドポイントを使用する必要があるため、次のどちらかまたは両方を使用できます。

• グローバル設定とエンドポイント：
  クエリは、すべてのコンテンツフラグメントモデルにアクセスできます。
• 特定の Sites 設定およびエンドポイント：
  特定の Sites 設定用の永続クエリを作成するには、対応する Sites 設定固有のエンドポイント（関連するコンテンツフラグメントモデルへのアクセスを提供）が必要です。例えば、WKND Sites 設定専用の永続クエリを作成するには、対応する WKND 固有の Sites 設定と、WKND 固有のエンドポイントを事前に作成する必要があります。

例えば、my-query という特定のクエリがあり、このクエリが Sites 設定 my-conf のモデル my-model を使用する場合は、次のようになります。

• 特定エンドポイント my-conf を使用してクエリを作成すると、クエリは次のように保存されます。
  /conf/my-conf/settings/graphql/persistentQueries/my-query
• global エンドポイントを使用して同じクエリを作成できますが、クエリは次のように保存されます。
  /conf/global/settings/graphql/persistentQueries/my-query

GraphQL クエリを永続化する方法

最初に AEM オーサー環境でクエリを永続化し、その後、アプリケーションで使用するために、実稼動 AEM パブリッシュ環境にクエリを移行することをお勧めします

クエリを永続化するには、次のような様々な方法があります。

• GraphiQL IDE — を参照してください。 永続クエリの保存 （推奨される方法）
• curl - 次の例を参照してください。
• その他のツール（Postman など）

GraphiQL IDE は、 優先 メソッドを使用してクエリを保持できます。 を使用して特定のクエリを保持するには curl コマンドラインツール：

1. 新しいエンドポイント URL /graphql/persist.json/<config>/<persisted-label> に PUT してクエリを準備します。

   例えば、次のようにして、永続的クエリを作成します。

   $ curl -X PUT \
       -H 'authorization: Basic YWRtaW46YWRtaW4=' \
       -H "Content-Type: application/json" \
       "http://localhost:4502/graphql/persist.json/wknd/plain-article-query" \
       -d \
   '{
     articleList {
       items{
           _path
           author
           main {
               json
           }
       }
     }
   }'
   

2. この段階で、応答を確認します。

   例えば、以下が成功するかどうかを確認します。

   {
     "action": "create",
     "configurationName": "wknd",
     "name": "plain-article-query",
     "shortPath": "/wknd/plain-article-query",
     "path": "/conf/wknd/settings/graphql/persistentQueries/plain-article-query"
   }
   

3. その後、URL /graphql/execute.json/<shortPath> を GET して、永続的クエリをリクエストできます。

   例えば、次のような永続的クエリを使用します。

   $ curl -X GET \
       http://localhost:4502/graphql/execute.json/wknd/plain-article-query
   

4. 既存のクエリパスに POST して、永続的クエリを更新します。

   例えば、次のような永続的クエリを使用します。

   $ curl -X POST \
       -H 'authorization: Basic YWRtaW46YWRtaW4=' \
       -H "Content-Type: application/json" \
       "http://localhost:4502/graphql/persist.json/wknd/plain-article-query" \
       -d \
   '{
     articleList {
       items{
           _path
           author
           main {
               json
           }
         referencearticle {
           _path
         }
       }
     }
   }'
   

5. ラップされたプレーンクエリを作成します。

   次に例を示します。

   $ curl -X PUT \
       -H 'authorization: Basic YWRtaW46YWRtaW4=' \
       -H "Content-Type: application/json" \
       "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-wrapped" \
       -d \
   '{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }"}'
   

6. キャッシュコントロール付きのラップされたプレーンクエリを作成します。

   次に例を示します。

   $ curl -X PUT \
       -H 'authorization: Basic YWRtaW46YWRtaW4=' \
       -H "Content-Type: application/json" \
       "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-max-age" \
       -d \
   '{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }", "cache-control": { "max-age": 300 }}'
   

7. パラメーター付きの永続的クエリを作成します。

   次に例を示します。

   $ curl -X PUT \
       -H 'authorization: Basic YWRtaW46YWRtaW4=' \
       -H "Content-Type: application/json" \
       "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-parameters" \
       -d \
   'query GetAsGraphqlModelTestByPath($apath: String!, $withReference: Boolean = true) {
     articleByPath(_path: $apath) {
       item {
         _path
           author
           main {
           plaintext
           }
           referencearticle @include(if: $withReference) {
           _path
           }
         }
       }
     }'
   

永続化クエリの実行方法

永続化されたクエリを実行するには、クライアントアプリケーションは次の構文を使用してGETリクエストを実行します。

GET <AEM_HOST>/graphql/execute.json/<PERSISTENT_PATH>

ここで、 PERSISTENT_PATH は、永続化されたクエリが保存されるへの短縮パスです。

1. 例： wknd は設定名で、 plain-article-query は、永続化されたクエリの名前です。 クエリを実行するには：

   $ curl -X GET \
       https://publish-p123-e456.adobeaemcloud.com/graphql/execute.json/wknd/plain-article-query
   

2. パラメーター付きのクエリを実行します。

   メモ

   クエリ変数と値は正しく設定されている必要があります エンコード済み 永続化クエリの実行時。

   次に例を示します。

   $ curl -X GET \
       "https://publish-p123-e456.adobeaemcloud.com/graphql/execute.json/wknd/plain-article-query-parameters%3Bapath%3D%2Fcontent%2Fdam%2Fwknd%2Fen%2Fmagazine%2Falaska-adventure%2Falaskan-adventures%3BwithReference%3Dfalse
   

   詳しくは、 クエリ変数 を参照してください。

クエリ変数の使用

クエリ変数は、永続化クエリで使用できます。 クエリ変数は、セミコロン (;) を変数名と値で使用します。 複数の変数はセミコロンで区切られます。

パターンは次のようになります。

<AEM_HOST>/graphql/execute.json/<PERSISTENT_QUERY_PATH>;variable1=value1;variable2=value2

例えば、次のクエリには変数が含まれています activity アクティビティの値に基づいてリストをフィルターするには：

query getAdventuresByActivity($activity: String!) {
      adventureList (filter: {
        adventureActivity: {
          _expressions: [
            {
              value: $activity
            }
          ]
        }
      }){
        items {
          _path
        adventureTitle
        adventurePrice
        adventureTripLength
      }
    }
  }

このクエリは、パスの下に保持できます wknd/adventures-by-activity. 永続化クエリを呼び出すには、次の手順に従います。 activity=Camping リクエストは次のようになります。

<AEM_HOST>/graphql/execute.json/wknd/adventures-by-activity%3Bactivity%3DCamping

注意： %3B は、 ; および %3D は =. クエリ変数と特殊文字は、次の条件を満たす必要があります。 適切にエンコード を実行します。

永続クエリのキャッシュ

永続化されたクエリは、Dispatcher および CDN レイヤーでキャッシュできるので、最終的には、要求元のクライアントアプリケーションのパフォーマンスを向上させることができます。

デフォルトでは、AEMはデフォルトの有効期間 (TTL) に基づいてコンテンツ配信ネットワーク (CDN) キャッシュを無効にします。

この値は次のように設定されます。

• Dispatcher および CDN のキャッシュ（共有キャッシュ​とも呼ばれます）のデフォルト TTL は 7200 秒です
  • デフォルト：s-maxage=7200
• クライアント（ブラウザーなど）のキャッシュのデフォルト TTL は 60 秒です
  • デフォルト：maxage=60

GraphLQ クエリの TTL を変更する場合は、次のいずれかのクエリを指定する必要があります。

• ～を管理した後に持続する HTTP キャッシュヘッダー — GraphQL IDE から
• を使用して持続する API メソッド.

GraphQL での HTTP キャッシュヘッダーの管理

GraphiQL IDE — を参照してください。 永続クエリの保存

API からのキャッシュの管理

これには、コマンドラインインターフェイスで CURL を使用して AEM にクエリをポストします。

次に例を示します。

curl -X PUT \
    -H 'authorization: Basic YWRtaW46YWRtaW4=' \
    -H "Content-Type: application/json" \
    "https://publish-p123-e456.adobeaemcloud.com/graphql/persist.json/wknd/plain-article-query-max-age" \
    -d \
'{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }", "cache-control": { "max-age": 300 }}'

cache-control は、作成時に設定することもできますし（PUT リクエストを使用）、後で設定することもできます（例えば、POST リクエストを使用）。AEM ではデフォルト値を提供できるので、永続クエリを作成する際に cache-control はオプションです。curl を使用してクエリを永続化する例については、GraphQL クエリを永続化する方法を参照してください。

アプリで使用するクエリ URL のエンコード

アプリケーションで使用する場合、クエリ変数を構築する際に使用される特殊文字 ( セミコロン (;)，等号 (=)、スラッシュ /) は、対応する UTF-8 エンコーディングを使用するように変換する必要があります。

次に例を示します。

curl -X GET \ "https://publish-p123-e456.adobeaemcloud.com/graphql/execute.json/wknd/adventure-by-path%3BadventurePath%3D%2Fcontent%2Fdam%2Fwknd%2Fen%2Fadventures%2Fbali-surf-camp%2Fbali-surf-camp"

URL は次の部分に分類できます。

プレーンテキストでは、リクエスト URI は次のようになります。

/graphql/execute.json/wknd/adventure-by-path;adventurePath=/content/dam/wknd/en/adventures/bali-surf-camp/bali-surf-camp

クライアントアプリで永続化されたクエリを使用するには、AEMヘッドレスクライアント SDK を JavaScript, Javaまたは NodeJS. ヘッドレスクライアント SDK は、リクエストで任意のクエリ変数を適切にエンコードします。

実稼動環境への永続的クエリの移行

永続化されたクエリは、常に AEM オーサーサービスで作成してから、AEM パブリッシュサービスに公開（レプリケート）する必要があります。 多くの場合、永続化クエリは、ローカル環境や開発環境などの低レベルの環境で作成およびテストされます。 その後、永続化されたクエリを上位レベルの環境に昇格し、最終的に、クライアントアプリケーションが使用できるように、実稼動 AEM パブリッシュ環境でクエリを使用できるようにする必要があります。

パッケージで保持されたクエリ

に永続クエリを組み込むことができます AEMパッケージ. その後、AEMパッケージを別の環境にダウンロードしてインストールできます。 AEMパッケージは、AEM オーサー環境から AEM パブリッシュ環境にレプリケートすることもできます。

パッケージを作成するには：

1. に移動します。 ツール > 導入 > パッケージ.
2. をタップして新しいパッケージを作成します。 パッケージを作成. パッケージを定義するダイアログが開きます。
3. パッケージ定義ダイアログで、 一般 入力 名前 例えば、「wknd-persistent-queries」などです。
4. 「1.0」のようなバージョン番号を入力します。
5. の下 フィルター 新しい フィルター. パスファインダーを使用して persistentQueries フォルダーの下に配置されます。 例： wknd フルパスの設定： /conf/wknd/settings/graphql/persistentQueries.
6. タップ 保存 新しいパッケージ定義を保存し、ダイアログを閉じます。
7. 次をタップします。 ビルド ボタンをクリックします。

パッケージが構築されたら、次の操作を実行できます。

• ダウンロード パッケージを別の環境に再度アップロードします。
• 複製 タップすることによるパッケージ 詳細 > 複製. 接続された AEM パブリッシュ環境にパッケージがレプリケートされます。

Business.Adobe.com リソース