基本的なクエリの作成 (VTL）

にサインイン AWS Management Console し、AppSync コンソール を開きます。

1. APIs ダッシュボード で、GraphQL を選択しますAPI。

2. サイドバーで [スキーマ] を選択します。

ページの右側には、[リゾルバー] というウィンドウがあります。このボックスには、ページの左側の [スキーマ] ウィンドウで定義されているタイプとフィールドのリストが含まれています。リゾルバーはフィールドにアタッチできます。たとえば、[クエリ] タイプで、getTodos フィールドの横にある [アタッチ] を選択します。

[リゾルバーの作成] ページで、「データソースを追加する」ガイドで作成したデータソースを選択します。[マッピングテンプレートの設定] ウィンドウでは、右側のドロップダウンリストを使用して汎用のリクエストおよびレスポンスのマッピングテンプレートを両方とも選択することも、独自のテンプレートを作成することもできます。

一般的なユースケースでは、 AWS AppSync コンソールには、データソースから項目を取得するために使用できるテンプレートが組み込まれています (すべての項目クエリ、個々のルックアップなど）。たとえば、「スキーマの設計」で使用したスキーマのシンプルバージョンでは、getTodos にページ分割がなく、項目を一覧表示するためのリクエストマッピングテンプレートは次のようになっていました。

{
    "version" : "2017-02-28",
    "operation" : "Scan"
}

リクエストに関連付けるレスポンスマッピングテンプレートが常に必要になります。コンソールには、リストの値をパススルーする次のようなデフォルトのテンプレートがあります。

$util.toJson($ctx.result.items)

この例では、項目のリストに対する context オブジェクト ($ctx としてエイリアスが作成された) の形式は $context.result.items です。GraphQL オペレーションが 1 つの項目を返した場合、それは になります$context.result。 AWS AppSync は、レスポンスを適切にフォーマットするための、前述の関数など、一般的なオペレーション用のヘルパー$util.toJson関数を提供します。関数の完全なリストについては、「リゾルバーのマッピングテンプレートのユーティリティリファレンス」を参照してください。

[リゾルバーを保存] を選択します。

を呼び出してリゾルバーオブジェクトを作成しますCreateResolverAPI。

を呼び出すことで、リゾルバーのフィールドを変更できますUpdateResolverAPI。

create-resolver コマンドを実行してリゾルバーを作成します。

このコマンドには次の 6 つのパラメータを入力する必要があります。

コマンドの例は、次のようになります。

aws appsync create-resolver --api-id abcdefghijklmnopqrstuvwxyz --type-name Query --field-name getTodos --data-source-name TodoTable --request-mapping-template "{ "version" : "2017-02-28", "operation" : "Scan", }" --response-mapping-template ""$"util.toJson("$"ctx.result.items)"

出力は に返されますCLI。例を示します。

{
    "resolver": {
        "kind": "UNIT",
        "dataSourceName": "TodoTable",
        "requestMappingTemplate": "{ version : 2017-02-28, operation : Scan, }",
        "resolverArn": "arn:aws:appsync:us-west-2:107289374856:apis/abcdefghijklmnopqrstuvwxyz/types/Query/resolvers/getTodos",
        "typeName": "Query",
        "fieldName": "getTodos",
        "responseMappingTemplate": "$util.toJson($ctx.result.items)"
    }
}

リゾルバーのフィールドおよび/またはマッピングテンプレートを変更するには、update-resolver コマンドを実行します。

api-id パラメータを除いて、create-resolver コマンドで使用されたパラメータは、update-resolver コマンドの新しい値で上書きされます。

にサインイン AWS Management Console し、AppSync コンソール を開きます。

1. APIs ダッシュボード で、GraphQL を選択しますAPI。

2. サイドバーで [スキーマ] を選択します。

[ミューテーション] タイプで、addTodo フィールドの横にある [アタッチ] を選択します。

[リゾルバーの作成] ページで、「データソースを追加する」ガイドで作成したデータソースを選択します。

このミューテーションでは DynamoDB に新しい項目を追加するため、[マッピングテンプレートの設定] ウィンドウでリクエストテンプレートを変更する必要があります。次のリクエストマッピングテンプレートを使用します。

{
    "version" : "2017-02-28",
    "operation" : "PutItem",
    "key" : {
        "id" : $util.dynamodb.toDynamoDBJson($ctx.args.id)
    },
    "attributeValues" : $util.dynamodb.toMapValuesJson($ctx.args)
}

AWS AppSync は、addTodoフィールドで定義された引数を GraphQL スキーマから DynamoDB オペレーションに自動的に変換します。上記の例では、ミューテーションの引数で $ctx.args.id として渡された id のキーを使用して、レコードが DynamoDB に保存されます。渡した他のすべてのフィールドは、$util.dynamodb.toMapValuesJson($ctx.args) を使用して自動的に DynamoDB 属性にマッピングされます。

このリゾルバーでは、次のレスポンスマッピングテンプレートを使用します。

$util.toJson($ctx.result)

AWS AppSync は、リゾルバーを編集するためのテストおよびデバッグワークフローもサポートしています。モック context オブジェクトを使用して、呼び出す前にテンプレートでの変換後の値を確認できます。また、クエリを実行する際にデータソースへのリクエストの実行全体をインタラクティブに表示することもできます。詳細については、「リゾルバーのテストとデバッグ」および「モニタリングとロギング」を参照してください。

[リゾルバーを保存] を選択します。

にサインイン AWS Management Console し、AppSync コンソール を開きます。

1. APIs ダッシュボード で、GraphQL を選択しますAPI。

2. サイドバーで [スキーマ] を選択します。

[Todo] タイプで、comments フィールドの横にある [アタッチ] を選択します。

[リゾルバーの作成] ページで、Comments テーブルのデータソースを選択します。クイックスタートガイドの Comments テーブルのデフォルト名は AppSyncCommentTable ですが、指定した名前によって異なる場合があります。

リクエストマッピングテンプレートに次のスニペットを追加します。

{
    "version": "2017-02-28",
    "operation": "Query",
    "index": "todoid-index",
    "query": {
        "expression": "todoid = :todoid",
        "expressionValues": {
            ":todoid": {
                "S": $util.toJson($context.source.id)
            }
        }
    }
}

context.source は、解決する現在のフィールドの親オブジェクトを参照します。この例では、source.id は個別の Todo オブジェクトを参照します。これはクエリ式に使用されます。

次のようにパススルーのレスポンスマッピングテンプレートを使用できます。

$util.toJson($ctx.result.items)

[リゾルバーを保存] を選択します。

最後に、コンソールの [スキーマ] ページで、リゾルバーを addComment フィールドにアタッチして Comments テーブルのデータソースを指定します。この例のリクエストマッピングテンプレートは、引数としてコメントされる特定の todoid を含む単純な PutItem ですが、次のように $utils.autoId() ユーティリティを使用してコメントに対して一意なソートキーを作成します。

{
    "version": "2017-02-28",
    "operation": "PutItem",
    "key": {
        "todoid": { "S": $util.toJson($context.arguments.todoid) },
        "commentid": { "S": "$util.autoId()" }
    },
    "attributeValues" : $util.dynamodb.toMapValuesJson($ctx.args)
}

次のようにパススルーレスポンステンプレートを使用します。

$util.toJson($ctx.result)