기본 쿼리 생성(VTL)

AWS Management Console에 로그인한 다음 AppSync 콘솔을 엽니다.

1. API 대시보드에서 GraphQL API를 선택합니다.

2. 사이드바에서 스키마를 선택합니다.

페이지 오른쪽에 해석기라는 창이 있습니다. 이 상자에는 페이지 왼쪽의 스키마 창에 정의된 유형 및 필드 목록이 있습니다. 필드에 해석기를 연결할 수 있습니다. 예를 들어 쿼리 유형에서 getTodos 필드 옆에 있는 첨부를 선택합니다.

해석기 생성 페이지에서 데이터 원본 연결 안내서에서 만든 데이터 원본을 선택합니다. 매핑 템플릿 구성 창에서 오른쪽의 드롭다운 목록을 사용하여 일반 요청 및 응답 매핑 템플릿을 모두 선택하거나 직접 작성할 수 있습니다.

일반적으로 AWS AppSync 콘솔에는 데이터 원본에서 항목을 가져오는 데 사용할 수 있는 내장 템플릿이 있습니다(예: 모든 항목 쿼리, 개별 조회 등). 예를 들어 getTodos에 페이지 매김이 없는 스키마 설계의 간단한 스키마 버전에서 항목을 나열하기 위한 요청 매핑 템플릿은 다음과 같습니다.

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

요청과 동반되는 응답 매핑 템플릿은 항상 필요합니다. 콘솔은 다음과 같은 목록에 대한 패스스루 값과 함께 기본값을 제공합니다.

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

이 예제에서 항목의 목록에 대한 context 객체(별칭 $ctx)는 $context.result.items 양식을 갖습니다. GraphQL 작업이 단일 항목을 반환하는 경우 이는 $context.result입니다. AWS AppSync는 이전에 나열된 $util.toJson 함수와 같은 일반 작업에 대해 도우미 함수를 제공하여 적절한 응답 형식을 지정합니다. 전체 함수 목록은 해석기 매핑 템플릿 유틸리티 참조를 참조하세요.

해석기 저장 을 선택합니다.

CreateResolver API를 호출하여 해석기 객체를 생성합니다.

UpdateResolver API를 호출하여 해석기의 필드를 수정할 수 있습니다.

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. API 대시보드에서 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는 GraphQL 스키마의 addTodo 필드에 정의된 인수를 DynamoDB 작업으로 자동으로 변환합니다. 이전 예에서는 변형 인수에서 전달된 id의 키를 $ctx.args.id로 사용하여 DynamoDB에 레코드를 저장합니다. 전달하는 다른 모든 필드는 $util.dynamodb.toMapValuesJson($ctx.args)을 사용하여 DynamoDB 특성에 자동으로 매핑됩니다.

이 해석기의 경우 다음 응답 매핑 템플릿을 사용합니다.

$util.toJson($ctx.result)

AWS AppSync는 또한 해석기 편집을 위한 테스트 및 디버그 워크플로를 지원합니다. 모의 context 객체를 사용하여 호출 전에 템플릿의 변환된 값을 확인할 수 있습니다. 선택적으로 쿼리를 실행할 때 대화식으로 데이터 원본에 대한 전체 요청 실행을 볼 수 있습니다. 자세한 내용은 해석기 테스트 및 디버깅 및 모니터링 및 로깅을 참조하세요.

해석기 저장 을 선택합니다.

AWS Management Console에 로그인한 다음 AppSync 콘솔을 엽니다.

1. API 대시보드에서 GraphQL API를 선택합니다.

2. 사이드바에서 스키마를 선택합니다.

Todo 유형에서 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)