Criar seu primeiro resolvedor Adicionar um resolvedor para mutações Resolvedores avançados

Configuração dos resolvedores (VTL)

nota

Agora, oferecemos suporte principalmente ao runtime do APPSYNC_JS e sua documentação. Considere usar o runtime do APPSYNC_JS e seus guias disponíveis aqui.

Os resolvedores do GraphQL conectam os campos em um esquema de tipo a uma fonte de dados. Os resolvedores são o mecanismo pelo qual as solicitações são atendidas. O AppSync pode criar e conectar resolvedores automaticamente a partir de um esquema ou criar um esquema e conectar resolvedores a partir de uma tabela existente sem a necessidade de escrever código.

Os resolvedores do AWS AppSync usam o JavaScript para converter uma expressão de GraphQL em um formato que a fonte de dados possa usar. Como alternativa, os modelos de mapeamento podem ser escritos em Apache VTL (Velocity Template Language) para converter uma expressão de GraphQL em um formato que a fonte de dados possa usar.

Esta seção mostrará como configurar resolvedores de VTL. Você encontra um guia de programação introdutório em estilo de tutorial para programação de resolvedores no guia de programação do modelo de mapeamento do resolvedor, além de utilitários auxiliares disponíveis na Referência de contexto do modelo de mapeamento. O AWS O AppSync também tem fluxos de teste e depuração integrados que podem ser usados para editar ou criar do zero. Para obter mais informações, consulte Resolvedores de teste e depuração.

Recomendamos seguir este guia antes de tentar usar qualquer um dos tutoriais mencionados acima.

Nesta seção, vamos criar um resolvedor, adicionar um resolvedor para mutações e usar as configurações avançadas.

Criar seu primeiro resolvedor

Seguindo os exemplos das seções anteriores, a primeira etapa é criar um resolvedor para seu tipo de Query.

Console

Faça login no AWS Management Console e abra o Console do AppSync.
1. No painel de APIs, escolha sua API GraphQL.
2. Na barra lateral, escolha Esquema.
No lado direito da página, há uma janela chamada Resolvedores. Essa caixa contém uma lista dos tipos e campos conforme definido na janela Esquema no lado esquerdo da página. Você pode anexar resolvedores aos campos. Por exemplo, no tipo de consulta, escolha Anexar ao lado do campo getTodos.
Na página Criar resolvedor, escolha a fonte de dados que você criou no guia Anexar uma fonte de dados. Na janela Configurar modelos de mapeamento, você pode escolher os modelos genéricos de mapeamento de solicitação e resposta na lista suspensa à direita ou escrever suas próprias opções.

nota
A combinação de um modelo de mapeamento de solicitação com um modelo de mapeamento de resposta é chamado de resolvedor de unidades. Os resolvedores de unidades normalmente são destinados a realizar operações rotineiras, e recomendamos usá-los somente para operações individuais com um pequeno número de fontes de dados. Para operações mais complexas, recomendamos o uso de resolvedores de pipeline, que podem executar diversas operações com várias fontes de dados sequencialmente.
Para obter mais informações sobre a diferença entre os modelos de mapeamento de solicitação e resposta, consulte Resolvedores de unidades.
Para obter mais informações sobre o uso de resolvedores de pipeline, consulte Resolvedores de pipeline.
Para casos de uso comuns, o console do AWS AppSync tem modelos integrados que podem ser usados para obter os itens das fontes de dados (todas as consultas de itens, pesquisas individuais etc.). Por exemplo, na versão simples do esquema de Projetar seu esquema, onde getTodos não tinha paginação, o modelo de mapeamento para listar os itens é o seguinte:
```
{
    "version" : "2017-02-28",
    "operation" : "Scan"
}
```
Sempre é necessário ter um modelo de mapeamento da resposta para acompanhar a solicitação. O console fornece um padrão com o seguinte valor de passagem para listas:
```
$util.toJson($ctx.result.items)
```
Neste exemplo, o objeto context (com o alias de $ctx) para listas de itens tem o formato $context.result.items. Se sua operação do GraphQL retornar um único item, ele seria $context.result. O AWS AppSync fornece funções auxiliares para operações comuns, como a função $util.toJson listada anteriormente, para criar respostas adequadamente. Para obter uma lista completa das funções, consulte Referência do utilitário do modelo de mapeamento do resolvedor.
Escolha Salvar resolvedor.

API

Crie um objeto resolvedor chamando a API CreateResolver.
Você pode modificar os campos do seu resolvedor chamando a API UpdateResolver.

CLI

Crie um resolvedor executando o comando create-resolver.

Você precisará digitar 6 parâmetros para este comando específico:

O api-id da sua API.
O type-name do tipo que você deseja modificar em seu esquema. No exemplo do console, tínhamos Query.
O field-name do tipo que você deseja modificar em seu tipo. No exemplo do console, tínhamos getTodos.
A fonte de dados data-source-name que você criou no guia Anexar uma fonte de dados.
O request-mapping-template, que é o corpo da solicitação. No exemplo do console, tínhamos:
```
{
    "version" : "2017-02-28",
    "operation" : "Scan"
}
```
O response-mapping-template, que é o corpo da resposta. No exemplo do console, tínhamos:
```
$util.toJson($ctx.result.items)
```

Veja um exemplo de comando:


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)"

Uma saída será retornada na CLI. Veja um exemplo abaixo:


{
    "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)"
    }
}

Para modificar os campos e/ou modelos de mapeamento de um resolvedor, execute o comando update-resolver.

Com exceção do parâmetro de api-id, os parâmetros usados no comando create-resolver serão substituídos pelos novos valores do comando update-resolver.

Adicionar um resolvedor para mutações

A próxima etapa é criar um resolvedor para seu tipo de Mutation.

Console

Faça login no AWS Management Console e abra o Console do AppSync.
1. No painel de APIs, escolha sua API GraphQL.
2. Na barra lateral, escolha Esquema.
No tipo Mutação, escolha Anexar ao lado do seu campo addTodo.
Na página Criar resolvedor, escolha a fonte de dados que você criou no guia Anexar uma fonte de dados.
Na janela Configurar modelos de mapeamento, você precisará modificar o modelo de solicitação porque essa é uma mutação em que você está adicionando um novo item ao DynamoDB. Use o seguinte modelo de mapeamento da solicitação:
```
{
    "version" : "2017-02-28",
    "operation" : "PutItem",
    "key" : {
        "id" : $util.dynamodb.toDynamoDBJson($ctx.args.id)
    },
    "attributeValues" : $util.dynamodb.toMapValuesJson($ctx.args)
}
```
O AWS AppSync converte automaticamente os argumentos definidos no campo addTodo do esquema do GraphQL para operações do DynamoDB. O exemplo anterior armazena registros no DynamoDB usando uma chave do id que é transmitida a partir do argumento da mutação como $ctx.args.id. Todos os outros campos transmitidos são mapeados automaticamente para atributos do DynamoDB com $util.dynamodb.toMapValuesJson($ctx.args).

Para esse resolvedor, use o seguinte modelo de mapeamento da resposta:
```
$util.toJson($ctx.result)
```
O AWS AppSync também oferece suporte para fluxos de trabalho de teste e depuração para edição dos resolvedores. Use um objeto context de simulação para ver o valor transformado do modelo antes de invocar. Opcionalmente, você pode visualizar a execução de solicitação completa para uma fonte de dados de forma interativa ao executar uma consulta. Para obter mais informações, consulte Resolvedores de teste e depuração e o Monitoramento e registro em log.
Escolha Salvar resolvedor.

API

Você também pode fazer isso com as APIs utilizando os comandos na seção Criar seu primeiro resolvedor e os detalhes dos parâmetros desta seção.

CLI

Além disso, é possível fazer isso no CLI utilizando os comandos na seção Criar seu primeiro resolvedor e os detalhes dos parâmetros desta seção.

Neste momento, se não estiver usando os resolvedores avançados você pode começar a usar a API GraphQL conforme descrito em Uso da API.

Resolvedores avançados

Se estiver seguindo a seção Avançado e estiver criando um esquema de exemplo em Projetar seu esquema para fazer uma verificação paginada, use o seguinte modelo de solicitação para o campo getTodos:


{
    "version" : "2017-02-28",
    "operation" : "Scan",
    "limit": $util.defaultIfNull(${ctx.args.limit}, 20),
    "nextToken": $util.toJson($util.defaultIfNullOrBlank($ctx.args.nextToken, null))
}

Para esse caso de uso de paginação, o mapeamento da resposta é mais do que apenas uma passagem porque ele deve conter o cursor (para que o cliente saiba em qual página começar) e o conjunto de resultados. O modelo de mapeamento é conforme mostrado a seguir:


{
    "todos": $util.toJson($context.result.items),
    "nextToken": $util.toJson($context.result.nextToken)
}

Os campos no modelo de mapeamento da resposta anterior devem corresponder aos campos definidos no tipo TodoConnection.

Se houver relações em que há uma tabela de Comments, e você estiver resolvendo o campo dos comentários no tipo Todo (que retorna um tipo de [Comment]), use um modelo de mapeamento que executa uma consulta mediante a segunda tabela. Para fazer isso, é necessário já ter criado uma fonte de dados para a tabela Comments, conforme descrito em Associar uma fonte de dados.

nota

Estamos usando uma operação de consulta mediante uma segunda tabela somente para fins ilustrativos. Você pode usar outra operação mediante o DynamoDB no lugar. Além disso, você pode obter os dados de outra fonte de dados, como o AWS Lambda ou o Amazon OpenSearch Service, pois a relação é controlada pelo esquema do GraphQL.

Console

Faça login no AWS Management Console e abra o Console do AppSync.
1. No painel de APIs, escolha sua API GraphQL.
2. Na barra lateral, escolha Esquema.
No tipo Tarefas, escolha Anexar ao lado do seu campo comments.
Na página Criar resolvedor, escolha sua fonte de dados da tabela de comentários. O nome padrão da tabela Comentários nos guias de início rápido é AppSyncCommentTable, mas pode variar dependendo do nome que você atribuiu a ela.

Adicione o seguinte trecho ao seu modelo de mapeamento da solicitação:


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

O context.source faz referência ao objeto pai do campo atual que está sendo resolvido. Neste exemplo, source.id se refere ao objeto Todo individual que é, então, usado para a expressão de consulta.

Você pode usar o modelo de mapeamento da resposta de passagem da seguinte forma:
```
$util.toJson($ctx.result.items)
```
Escolha Salvar resolvedor.
Por fim, de volta à página Esquema no console, anexe um resolvedor ao campo addComment e especifique a fonte de dados da tabela Comments. Neste caso, o modelo de mapeamento da solicitação é um simples PutItem com o todoid específico que está comentado como um argumento, mas use o utilitário $utils.autoId() para criar uma chave de classificação única para o comentário da seguinte forma:
```
{
    "version": "2017-02-28",
    "operation": "PutItem",
    "key": {
        "todoid": { "S": $util.toJson($context.arguments.todoid) },
        "commentid": { "S": "$util.autoId()" }
    },
    "attributeValues" : $util.dynamodb.toMapValuesJson($ctx.args)
}
```
Use um modelo da resposta de passagem da seguinte forma:
```
$util.toJson($ctx.result)
```

API

Você também pode fazer isso com as APIs utilizando os comandos na seção Criar seu primeiro resolvedor e os detalhes dos parâmetros desta seção.

CLI

Além disso, é possível fazer isso no CLI utilizando os comandos na seção Criar seu primeiro resolvedor e os detalhes dos parâmetros desta seção.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Resolvedores de pipeline (JavaScript)

Resolvedores diretos do Lambda (VTL)