Criação de consultas básicas (JavaScript) - AWS AppSync GraphQL

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Criação de consultas básicas (JavaScript)

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.

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 descreve como configurar resolvedores usando JavaScript. A seção Tutoriais do Resolver (JavaScript) fornece tutoriais detalhados sobre como implementar resolvedores usando JavaScript. A seção Referência do resolvedor (JavaScript) fornece uma explicação das operações do utilitário que podem ser usadas com resolvedores de JavaScript.

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

Nesta seção, mostraremos como criar e configurar resolvedores de consultas e mutações.

nota

Este guia pressupõe que você tenha criado seu esquema e tenha pelo menos uma consulta ou mutação. Se você estiver procurando por assinaturas (dados em tempo real), consulte este guia.

Nesta seção, abordaremos algumas etapas gerais para configurar resolvedores e mostraremos um exemplo com o esquema abaixo:

// schema.graphql file input CreatePostInput { title: String date: AWSDateTime } type Post { id: ID! title: String date: AWSDateTime } type Mutation { createPost(input: CreatePostInput!): Post } type Query { getPost: [Post] }

Criação de resolvedores de consultas básicos

Esta seção mostrará como criar um resolvedor de consultas básico.

Console
  1. 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.

  2. Insira os detalhes do esquema e da fonte de dados. Consulte as seções Criar seu esquema e Anexar uma fonte de dados para obter mais informações.

  3. Ao lado do editor de esquemas, há uma janela chamada Resolvedores. Essa caixa contém uma lista dos tipos e campos conforme definido na janela Esquema. É possível anexar resolvedores aos campos. Você provavelmente estará anexando resolvedores às suas operações de campo. Nesta seção, veremos configurações de consultas simples. Em Tipo de consulta, escolha Anexar ao lado do campo da sua consulta.

  4. Na página Anexar resolvedor, em Tipo de resolvedor, você pode escolher entre resolvedores de pipeline ou de unidade. Para obter mais informações sobre esses tipos de regra, consulte Resolvedores. Este guia fará uso de pipeline resolvers.

    dica

    Ao criar resolvedores de pipeline, suas fontes de dados serão anexadas às funções do pipeline. As funções são geradas depois que você cria o próprio resolvedor de pipeline, e é por isso que não há opção de configurá-lo nesta página. Se você estiver usando um resolvedor de unidades, a fonte de dados estará vinculada diretamente ao resolvedor, portanto, você o definiria nesta página.

    Para Runtime do resolvedor, escolha APPSYNC_JS para ativar o runtime do JavaScript.

  5. Você pode ativar o armazenamento em cache dessa API. Recomendamos desativar esse atributo por enquanto. Selecione Criar.

  6. Na página Editar resolvedor, há um editor de código chamado Código do resolvedor que permite implementar a lógica para o manipulador e a resposta do resolvedor (etapas anterior e posterior). Para obter mais informações, consulte JavaScript resolvers overview.

    nota

    Em nosso exemplo, vamos deixar a solicitação em branco e a resposta definida para retornar o resultado da última fonte de dados do contexto:

    import {util} from '@aws-appsync/utils'; export function request(ctx) { return {}; } export function response(ctx) { return ctx.prev.result; }

    Abaixo dessa seção, há uma tabela chamada Funções. As funções permitem que você implemente códigos que possam ser reutilizados em vários resolvedores. Em vez de reescrever ou copiar sempre o código, você pode armazenar o código-fonte como uma função a ser adicionada a um resolvedor sempre que precisar.

    As funções compõem a maior parte da lista de operações de um pipeline. Ao usar várias funções em um resolvedor, você define a ordem das funções, e elas serão executadas nessa ordem sequencialmente. Elas são executadas depois da função de solicitação e antes do início da função de resposta.

    Para adicionar uma nova função, em Funções, escolha Adicionar função e, em seguida, Criar nova função. Como alternativa, pode haver um botão Criar função para escolher.

    1. Escolha uma fonte de dados. Essa será a fonte de dados em que o resolvedor vai atuar.

      nota

      Em nosso exemplo, estamos anexando um resolvedor para getPost, que recupera um objeto Post pelo id. Vamos supor que já tenhamos configurado uma tabela do DynamoDB para esse esquema. Sua chave de partição está vazia e definida como id.

    2. Insira um Function name.

    3. Em Código da função, você precisará implementar o comportamento da função. Isso pode ser confuso, mas cada função terá seu próprio manipulador local de solicitações e respostas. A solicitação é executada e, em seguida, a invocação da fonte de dados é feita para lidar com a solicitação e, em seguida, a resposta da fonte de dados é processada pelo manipulador. O resultado é armazenado no objeto do contexto. Depois disso, a próxima função na lista será executada ou transmitida para o manipulador de resposta da etapa posterior, se for a última.

      nota

      Em nosso exemplo, estamos anexando um resolvedor ao getPost, que obtém uma lista de objetos Post da fonte de dados. Nossa função de solicitação vai demandar os dados da nossa tabela, que transmitirá a resposta ao contexto (ctx) e, em seguida, a resposta retornará o resultado no contexto. A força do AWS AppSync está em sua interconexão com outros serviços da AWS. Como estamos usando o DynamoDB, temos um conjunto de operações para simplificar processos como esses. Também temos alguns exemplos padronizados para outros tipos de fontes de dados.

      Nosso código será semelhante a este:

      import { util } from '@aws-appsync/utils'; /** * Performs a scan on the dynamodb data source */ export function request(ctx) { return { operation: 'Scan' }; } /** * return a list of scanned post items */ export function response(ctx) { return ctx.result.items; }

      Nesta etapa, adicionamos duas funções:

      • request: o manipulador de solicitações executa a operação de recuperação na fonte de dados. O argumento contém o objeto de contexto (ctx) ou alguns dados que estão disponíveis para todos os resolvedores que executam uma operação específica. Por exemplo, ele pode conter dados de autorização, os nomes dos campos que estão sendo resolvidos etc. A instrução return executa uma operação de Scan (confira exemplos aqui). Como estamos trabalhando com o DynamoDB, podemos usar algumas das operações desse serviço. A verificação executa uma busca básica de todos os itens em nossa tabela. O resultado dessa operação é armazenado no objeto de contexto como um contêiner de result antes de ser transmitido ao manipulador de respostas. A request é executada antes da resposta no pipeline.

      • response: o manipulador de respostas que retorna o resultado da request. O argumento é o objeto de contexto atualizado e a instrução de retorno é ctx.prev.result. Neste ponto do guia, é possível que você não conheça esse valor. ctx refere-se ao objeto de contexto, e prev refere-se à operação anterior no pipeline, que era nossa request. O result contém os resultados do resolvedor à medida que ele se move pelo pipeline. Se você juntar tudo isso, ctx.prev.result está retornando o resultado da última operação realizada, que foi o manipulador da solicitação.

    4. Depois de concluir, escolha Criar.

  7. De volta à tela do resolvedor, em Funções, escolha o menu suspenso Adicionar função e inclua sua função na sua lista.

  8. Escolha Salvar para atualizar o resolvedor.

CLI

Para adicionar sua função

  • Crie uma função para seu resolvedor de pipeline usando o comando create-function.

    Você precisará inserir alguns parâmetros para esse comando específico:

    1. O api-id da sua API.

    2. O name da função no console do AWS AppSync.

    3. O data-source-name, ou o nome da fonte de dados que a função usará. Ele já deve ter sido criado e vinculado à sua API do GraphQL no serviço do AWS AppSync.

    4. Oruntime, ou ambiente e idioma da função. Para JavaScript, o nome deve ser APPSYNC_JS, e o runtime, 1.0.0.

    5. O code, ou manipuladores de solicitações e respostas de sua função. Embora você possa digitá-lo manualmente, é muito mais fácil adicioná-lo a um arquivo .txt (ou formato similar) e depois transmiti-lo como argumento.

      nota

      Nosso código de consulta estará em um arquivo transmitido como argumento:

      import { util } from '@aws-appsync/utils'; /** * Performs a scan on the dynamodb data source */ export function request(ctx) { return { operation: 'Scan' }; } /** * return a list of scanned post items */ export function response(ctx) { return ctx.result.items; }

    Veja um exemplo de comando:

    aws appsync create-function \ --api-id abcdefghijklmnopqrstuvwxyz \ --name get_posts_func_1 \ --data-source-name table-for-posts \ --runtime name=APPSYNC_JS,runtimeVersion=1.0.0 \ --code file://~/path/to/file/{filename}.{fileType}

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

    { "functionConfiguration": { "functionId": "ejglgvmcabdn7lx75ref4qeig4", "functionArn": "arn:aws:appsync:us-west-2:107289374856:apis/abcdefghijklmnopqrstuvwxyz/functions/ejglgvmcabdn7lx75ref4qeig4", "name": "get_posts_func_1", "dataSourceName": "table-for-posts", "maxBatchSize": 0, "runtime": { "name": "APPSYNC_JS", "runtimeVersion": "1.0.0" }, "code": "Code output goes here" } }
    nota

    Certifique-se de gravar o functionId em algum lugar, pois isso será usado para anexar a função ao solucionados.

Criar seu resolvedor

  • Crie uma função de pipeline para Query executando o comando create-resolver.

    Você precisará inserir alguns parâmetros para esse comando específico:

    1. O api-id da sua API.

    2. O type-name, ou o tipo de objeto especial em seu esquema (consulta, mutação, assinatura).

    3. O field-name ou a operação do campo no tipo de objeto especial a ser anexado ao resolvedor.

    4. O kind, que especifica um resolvedor de unidade ou pipeline. Defina como PIPELINE para ativar as funções do pipeline.

    5. A pipeline-config, ou as funções a serem anexadas ao resolvedor. É preciso saber os valores de functionId de suas funções. A ordem da listagem é importante.

    6. O runtime, que foi APPSYNC_JS (JavaScript). Atualmente o runtimeVersion é1.0.0.

    7. O code, que contém os manipuladores das etapas anterior e posterior.

      nota

      Nosso código de consulta estará em um arquivo transmitido como argumento:

      import { util } from '@aws-appsync/utils'; /** * Sends a request to `put` an item in the DynamoDB data source */ export function request(ctx) { const { id, ...values } = ctx.args; return { operation: 'PutItem', key: util.dynamodb.toMapValues({ id }), attributeValues: util.dynamodb.toMapValues(values), }; } /** * returns the result of the `put` operation */ export function response(ctx) { return ctx.result; }

    Veja um exemplo de comando:

    aws appsync create-resolver \ --api-id abcdefghijklmnopqrstuvwxyz \ --type-name Query \ --field-name getPost \ --kind PIPELINE \ --pipeline-config functions=ejglgvmcabdn7lx75ref4qeig4 \ --runtime name=APPSYNC_JS,runtimeVersion=1.0.0 \ --code file:///path/to/file/{filename}.{fileType}

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

    { "resolver": { "typeName": "Mutation", "fieldName": "getPost", "resolverArn": "arn:aws:appsync:us-west-2:107289374856:apis/abcdefghijklmnopqrstuvwxyz/types/Mutation/resolvers/getPost", "kind": "PIPELINE", "pipelineConfig": { "functions": [ "ejglgvmcabdn7lx75ref4qeig4" ] }, "maxBatchSize": 0, "runtime": { "name": "APPSYNC_JS", "runtimeVersion": "1.0.0" }, "code": "Code output goes here" } }
CDK
dica

Antes de usar o CDK, leia a documentação oficial junto com a referência do CDK do AWS AppSync.

As etapas listadas abaixo mostram apenas um exemplo geral do trecho usado para adicionar um recurso específico. Isso não é uma solução funcional para seu código de produção. Também presumimos que você já tenha uma aplicação em funcionamento.

Uma aplicação básica precisará do seguinte:

  1. Diretivas de importação de serviços

  2. Código do esquema

  3. Gerador de fontes de dados

  4. Código da função

  5. Código do resolvedor

Nas seções Projetar seu esquema e Anexar uma fonte de dados, sabemos que o arquivo de pilha incluirá as diretivas de importação do formulário:

import * as x from 'x'; # import wildcard as the 'x' keyword from 'x-service' import {a, b, ...} from 'c'; # import {specific constructs} from 'c-service'
nota

Nas seções anteriores, declaramos apenas como importar estruturas do AWS AppSync. Em código real, você precisará importar mais serviços apenas para executar a aplicação. Em nosso exemplo, se criássemos uma aplicação do CDK muito simples, importaríamos pelo menos o serviço do AWS AppSync junto com nossa fonte de dados, que era uma tabela do DynamoDB. Também precisaríamos importar algumas estruturas adicionais para implantar a aplicação:

import * as cdk from 'aws-cdk-lib'; import * as appsync from 'aws-cdk-lib/aws-appsync'; import * as dynamodb from 'aws-cdk-lib/aws-dynamodb'; import { Construct } from 'constructs';

Para resumir cada uma delas:

  • import * as cdk from 'aws-cdk-lib';: isso permite que você defina a aplicação e as estruturas do CDK, como a pilha. Ela também contém algumas funções utilitárias relevantes para nosso aplicativo, como a manipulação de metadados. Se você já conhece essa diretiva de importação, mas não sabe por que a biblioteca principal do CDK não está sendo usada aqui, consulte a página de migração.

  • import * as appsync from 'aws-cdk-lib/aws-appsync';: isso importa o serviço do AWS AppSync.

  • import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';: isso importa o serviço do DynamoDB.

  • import { Construct } from 'constructs';: precisamos disso para definir a estrutura-raiz.

O tipo de importação depende dos serviços que você está chamando. Recomendamos consultar a documentação do CDK para ver exemplos. O esquema na parte superior da página será um arquivo separado na sua aplicação do CDK como um arquivo .graphql. No arquivo de pilha, podemos associá-lo a um novo GraphQL usando este formato:

const add_api = new appsync.GraphqlApi(this, 'graphQL-example', { name: 'my-first-api', schema: appsync.SchemaFile.fromAsset(path.join(__dirname, 'schema.graphql')), });
nota

No escopo do add_api, vamos adicionar uma nova API GraphQL usando a new palavra-chave seguida por appsync.GraphqlApi(scope: Construct, id: string , props: GraphqlApiProps). Nosso escopo é this, o ID do CFN é graphQL-example, e nossas propriedades são my-first-api (nome da API no console) e schema.graphql (o caminho absoluto para o arquivo do esquema).

Para incluir uma fonte de dados, primeiro você precisa adicionar sua fonte de dados à pilha. Em seguida, associá-la à API GraphQL usando o método específico da fonte. A associação acontecerá quando seu resolvedor funcionar. Enquanto isso, vamos usar um exemplo criando a tabela do DynamoDB usando dynamodb.Table:

const add_ddb_table = new dynamodb.Table(this, 'posts-table', { partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING, }, });
nota

Se usássemos isso em nosso exemplo, adicionaríamos uma nova tabela do DynamoDB com o ID do CFN e uma chave de partição posts-table do id (S).

Em seguida, precisamos implementar nosso resolvedor no arquivo de pilha. Veja a seguir um exemplo de uma consulta simples que verifica todos os itens em uma tabela do DynamoDB:

const add_func = new appsync.AppsyncFunction(this, 'func-get-posts', { name: 'get_posts_func_1', add_api, dataSource: add_api.addDynamoDbDataSource('table-for-posts', add_ddb_table), code: appsync.Code.fromInline(` export function request(ctx) { return { operation: 'Scan' }; } export function response(ctx) { return ctx.result.items; } `), runtime: appsync.FunctionRuntime.JS_1_0_0, }); new appsync.Resolver(this, 'pipeline-resolver-get-posts', { add_api, typeName: 'Query', fieldName: 'getPost', code: appsync.Code.fromInline(` export function request(ctx) { return {}; } export function response(ctx) { return ctx.prev.result; } `), runtime: appsync.FunctionRuntime.JS_1_0_0, pipelineConfig: [add_func], });
nota

Primeiro, criamos uma função chamada add_func. Essa ordem de criação pode parecer um pouco contraintuitiva, mas você precisa criar as funções em seu resolvedor de pipeline antes de criar o próprio resolvedor. Uma função segue o formato:

AppsyncFunction(scope: Construct, id: string, props: AppsyncFunctionProps)

Nosso escopo era this, nosso ID de CFN, func-get-posts, e nossas propriedades continham os detalhes reais da função. Dentro das propriedades, incluímos:

  • O name da função que estará presente no console do AWS AppSync (get_posts_func_1).

  • A API GraphQL que criamos anteriormente (add_api).

  • A fonte de dados; esse é o ponto em que vinculamos a fonte de dados ao valor da API GraphQL e a anexamos à função. Pegamos a tabela que criamos (add_ddb_table) e a anexamos à API GraphQL (add_api) usando um dos métodos GraphqlApi (addDynamoDbDataSource). O valor do ID (table-for-posts) é o nome da fonte de dados no console do AWS AppSync. Para obter a lista dos métodos específicos da fonte, consulte as seguintes páginas:

  • O código contém os manipuladores de solicitações e respostas da nossa função, que são uma simples digitalização e retorno.

  • O runtime especifica que queremos usar a versão 1.0.0 do runtime do APPSYNC_JS. Observe que atualmente essa é a única versão disponível do APPSYNC_JS.

Em seguida, precisamos anexar a função ao resolvedor de pipeline. Criamos nosso resolvedor usando o formulário:

Resolver(scope: Construct, id: string, props: ResolverProps)

Nosso escopo era this, nosso ID de CFN, pipeline-resolver-get-posts, e nossas propriedades continham os detalhes reais da função. Dentro das propriedades, incluímos:

  • A API GraphQL que criamos anteriormente (add_api).

  • O nome do tipo de objeto especial; essa é uma operação de consulta, então só adicionamos o valor da Query.

  • O nome do campo (getPost) é aquele no esquema abaixo do tipo de Query.

  • O código contém seus manipuladores de antes e depois. Nosso exemplo só vão retornar os resultados que estavam no contexto depois que a função tiver executado a operação.

  • O runtime especifica que queremos usar a versão 1.0.0 do runtime do APPSYNC_JS. Observe que atualmente essa é a única versão disponível do APPSYNC_JS.

  • A configuração do pipeline contém a referência à função que criamos (add_func).

Para resumir o que aconteceu neste exemplo, você viu uma função do AWS AppSync que implementou um manipulador de solicitações e respostas. A função foi responsável por interagir com sua fonte de dados. O manipulador da solicitação enviou uma operação de Scan para o AWS AppSync, instruindo-a sobre qual operação realizar na sua fonte de dados do DynamoDB. O manipulador de respostas retornou a lista de itens (ctx.result.items). A lista de itens foi então mapeada automaticamente para o tipo Post GraphQL.

Criar resolvedores básicos de mutação

Esta seção mostrará como criar um resolvedor de mutação básico.

Console
  1. 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.

  2. Na seção Resolvedores e no tipo de mutação, escolha Anexar ao lado do seu campo.

    nota

    Em nosso exemplo, estamos anexando um resolvedor para createPost, que recupera um objeto Post para nossa tabela. Vamos supor que estamos usando a mesma tabela do DynamoDB da última seção. Sua chave de partição está vazia e definida como id.

  3. Na página Anexar resolvedor, em Tipo de resolvedor, escolha pipeline resolvers. Como lembrete, você pode encontrar mais informações sobre resolvedores aqui. Para Runtime do resolvedor, escolha APPSYNC_JS para ativar o runtime do JavaScript.

  4. Você pode ativar o armazenamento em cache dessa API. Recomendamos desativar esse atributo por enquanto. Selecione Criar.

  5. Escolha Adicionar função e, em seguida, Criar nova função. Como alternativa, pode haver um botão Criar função para escolher.

    1. Selecione sua fonte de dados. Essa deve ser a fonte cujos dados você manipulará com a mutação.

    2. Insira um Function name.

    3. Em Código da função, você precisará implementar o comportamento da função. Isso é uma mutação, portanto, o ideal é que a solicitação realize alguma operação de mudança de estado na fonte de dados invocada. O resultado será processado pela função de resposta.

      nota

      O createPost adiciona ou “insere” um novo Post na tabela com nossos parâmetros como dados. Isso pode ser semelhante a:

      import { util } from '@aws-appsync/utils'; /** * Sends a request to `put` an item in the DynamoDB data source */ export function request(ctx) { return { operation: 'PutItem', key: util.dynamodb.toMapValues({id: util.autoId()}), attributeValues: util.dynamodb.toMapValues(ctx.args.input), }; } /** * returns the result of the `put` operation */ export function response(ctx) { return ctx.result; }

      Nesta etapa, adicionamos as funções request e response:

      • request: o manipulador da solicitação aceita o contexto como argumento. A instrução return do manipulador de solicitações executa um comando PutItem, que é uma operação integrada do DynamoDB (confira alguns exemplos neste link ou aqui). O comando PutItem adiciona um objeto Post à nossa tabela do DynamoDB considerando o valor key da partição (gerado automaticamente por util.autoid()) e attributes a partir da entrada do argumento de contexto (esses são os valores que vamos transmitir em nossa solicitação). A key é o id, e os attributes são os argumentos de campo date e title. Ambos são pré-formatados por meio do auxiliar util.dynamodb.toMapValues para trabalhar com a tabela do DynamoDB.

      • response: a resposta aceita o contexto atualizado e retorna o resultado do manipulador da solicitação.

    4. Depois de concluir, escolha Criar.

  6. De volta à tela do resolvedor, em Funções, escolha o menu suspenso Adicionar função e inclua sua função na sua lista.

  7. Escolha Salvar para atualizar o resolvedor.

CLI

Para adicionar sua função

  • Crie uma função para seu resolvedor de pipeline usando o comando create-function.

    Você precisará inserir alguns parâmetros para esse comando específico:

    1. O api-id da sua API.

    2. O name da função no console do AWS AppSync.

    3. O data-source-name, ou o nome da fonte de dados que a função usará. Ele já deve ter sido criado e vinculado à sua API do GraphQL no serviço do AWS AppSync.

    4. Oruntime, ou ambiente e idioma da função. Para JavaScript, o nome deve ser APPSYNC_JS, e o runtime, 1.0.0.

    5. O code, ou manipuladores de solicitações e respostas de sua função. Embora você possa digitá-lo manualmente, é muito mais fácil adicioná-lo a um arquivo .txt (ou formato similar) e depois transmiti-lo como argumento.

      nota

      Nosso código de consulta estará em um arquivo transmitido como argumento:

      import { util } from '@aws-appsync/utils'; /** * Sends a request to `put` an item in the DynamoDB data source */ export function request(ctx) { return { operation: 'PutItem', key: util.dynamodb.toMapValues({id: util.autoId()}), attributeValues: util.dynamodb.toMapValues(ctx.args.input), }; } /** * returns the result of the `put` operation */ export function response(ctx) { return ctx.result; }

    Veja um exemplo de comando:

    aws appsync create-function \ --api-id abcdefghijklmnopqrstuvwxyz \ --name add_posts_func_1 \ --data-source-name table-for-posts \ --runtime name=APPSYNC_JS,runtimeVersion=1.0.0 \ --code file:///path/to/file/{filename}.{fileType}

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

    { "functionConfiguration": { "functionId": "vulcmbfcxffiram63psb4dduoa", "functionArn": "arn:aws:appsync:us-west-2:107289374856:apis/abcdefghijklmnopqrstuvwxyz/functions/vulcmbfcxffiram63psb4dduoa", "name": "add_posts_func_1", "dataSourceName": "table-for-posts", "maxBatchSize": 0, "runtime": { "name": "APPSYNC_JS", "runtimeVersion": "1.0.0" }, "code": "Code output foes here" } }
    nota

    Certifique-se de gravar o functionId em algum lugar, pois isso será usado para anexar a função ao solucionados.

Criar seu resolvedor

  • Crie uma função de pipeline para Mutation executando o comando create-resolver.

    Você precisará inserir alguns parâmetros para esse comando específico:

    1. O api-id da sua API.

    2. O type-name, ou o tipo de objeto especial em seu esquema (consulta, mutação, assinatura).

    3. O field-name ou a operação do campo no tipo de objeto especial a ser anexado ao resolvedor.

    4. O kind, que especifica um resolvedor de unidade ou pipeline. Defina como PIPELINE para ativar as funções do pipeline.

    5. A pipeline-config, ou as funções a serem anexadas ao resolvedor. É preciso saber os valores de functionId de suas funções. A ordem da listagem é importante.

    6. O runtime, que foi APPSYNC_JS (JavaScript). Atualmente o runtimeVersion é1.0.0.

    7. O code, que contém os manipuladores das etapas anterior e posterior.

      nota

      Nosso código de consulta estará em um arquivo transmitido como argumento:

      import { util } from '@aws-appsync/utils'; /** * Sends a request to `put` an item in the DynamoDB data source */ export function request(ctx) { const { id, ...values } = ctx.args; return { operation: 'PutItem', key: util.dynamodb.toMapValues({ id }), attributeValues: util.dynamodb.toMapValues(values), }; } /** * returns the result of the `put` operation */ export function response(ctx) { return ctx.result; }

    Veja um exemplo de comando:

    aws appsync create-resolver \ --api-id abcdefghijklmnopqrstuvwxyz \ --type-name Mutation \ --field-name createPost \ --kind PIPELINE \ --pipeline-config functions=vulcmbfcxffiram63psb4dduoa \ --runtime name=APPSYNC_JS,runtimeVersion=1.0.0 \ --code file:///path/to/file/{filename}.{fileType}

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

    { "resolver": { "typeName": "Mutation", "fieldName": "createPost", "resolverArn": "arn:aws:appsync:us-west-2:107289374856:apis/abcdefghijklmnopqrstuvwxyz/types/Mutation/resolvers/createPost", "kind": "PIPELINE", "pipelineConfig": { "functions": [ "vulcmbfcxffiram63psb4dduoa" ] }, "maxBatchSize": 0, "runtime": { "name": "APPSYNC_JS", "runtimeVersion": "1.0.0" }, "code": "Code output goes here" } }
CDK
dica

Antes de usar o CDK, leia a documentação oficial junto com a referência do CDK do AWS AppSync.

As etapas listadas abaixo mostram apenas um exemplo geral do trecho usado para adicionar um recurso específico. Isso não é uma solução funcional para seu código de produção. Também presumimos que você já tenha uma aplicação em funcionamento.

  • Para fazer uma mutação, supondo que esteja no mesmo projeto, você pode adicioná-la ao arquivo de pilha como na consulta. Aqui está uma função e um resolvedor modificados para uma mutação que adiciona uma nova Post à tabela:

    const add_func_2 = new appsync.AppsyncFunction(this, 'func-add-post', { name: 'add_posts_func_1', add_api, dataSource: add_api.addDynamoDbDataSource('table-for-posts-2', add_ddb_table), code: appsync.Code.fromInline(` export function request(ctx) { return { operation: 'PutItem', key: util.dynamodb.toMapValues({id: util.autoId()}), attributeValues: util.dynamodb.toMapValues(ctx.args.input), }; } export function response(ctx) { return ctx.result; } `), runtime: appsync.FunctionRuntime.JS_1_0_0, }); new appsync.Resolver(this, 'pipeline-resolver-create-posts', { add_api, typeName: 'Mutation', fieldName: 'createPost', code: appsync.Code.fromInline(` export function request(ctx) { return {}; } export function response(ctx) { return ctx.prev.result; } `), runtime: appsync.FunctionRuntime.JS_1_0_0, pipelineConfig: [add_func_2], });
    nota

    Como essa mutação e a consulta são estruturadas de forma semelhante, explicaremos apenas as alterações que implementamos para fazer a mutação.

    Na função, alteramos o ID da CFN func-add-post e o nome para add_posts_func_1 para refletir o fato de que estamos adicionando Posts à tabela. Na fonte de dados, fizemos uma nova associação à nossa tabela (add_ddb_table) no AWS AppSync console table-for-posts-2 porque o método addDynamoDbDataSource exige isso. Lembre-se de que essa nova associação ainda está usando a mesma tabela que criamos anteriormente, mas agora temos duas conexões com ela no console do AWS AppSync: uma para a consulta como table-for-posts e outra para a mutação como table-for-posts-2. O código foi alterado para adicionar uma Post gerando o valor do id automaticamente e aceitando a entrada de um cliente para o resto dos campos.

    No resolvedor, mudamos o valor do ID para pipeline-resolver-create-posts a fim de refletir o fato de que estamos adicionando Posts à tabela. Para refletir a mutação no esquema, o nome do tipo mudou para Mutation, e o nome para createPost. A configuração do pipeline foi definida para nossa nova função de mutação add_func_2.

Para resumir o que está acontecendo neste exemplo, o AWS AppSync converte automaticamente os argumentos definidos no campo createPost do seu esquema do GraphQL em operações do DynamoDB. O exemplo armazena registros no DynamoDB usando uma chave do id, que é criada automaticamente usando nosso auxiliar util.autoId(). Todos os outros campos que você transmitir para os argumentos de contexto (ctx.args.input) das solicitações feitas no AWS AppSync console ou de outra forma serão armazenados como atributos da tabela. Tanto a chave quanto os atributos são mapeados automaticamente para um formato compatível do DynamoDB usando o auxiliar util.dynamodb.toMapValues(values).

O AWS AppSync também oferece suporte para fluxos de trabalho de teste e depuração para edição de resolvedores. Use um objeto context de simulação para ver o valor do modelo transformado antes da invocá-lo. Uma alternativa é visualizar a execução de solicitação completa de uma fonte de dados de forma interativa ao executar uma consulta. Para obter mais informações, consulte Resolvedores de teste e depuração (JavaScript) e Monitoramento e registro em log.

Resolvedores avançados

Se você estiver seguindo a seção opcional de paginação em Projetar seu esquema, ainda precisará adicionar seu resolvedor à sua solicitação para usar a paginação. Nosso exemplo usou uma paginação de consulta chamada getPosts para retornar somente uma parte das coisas solicitadas por vez. O código do nosso resolvedor nesse campo pode ter a seguinte aparência:

/** * Performs a scan on the dynamodb data source */ export function request(ctx) { const { limit = 20, nextToken } = ctx.args; return { operation: 'Scan', limit, nextToken }; } /** * @returns the result of the `put` operation */ export function response(ctx) { const { items: posts = [], nextToken } = ctx.result; return { posts, nextToken }; }

Na solicitação, transmitimos no contexto dela. Nosso limit é 20, o que significa que retornamos até 20 Posts na primeira consulta. Nosso cursor do nextToken está fixo na primeira entrada da Post na fonte de dados. Eles são transmitidos para os argumentos. Em seguida, a solicitação executa uma varredura desde a primeira Post até o número limite de varredura. A fonte de dados armazena o resultado no contexto, que é transmitido para a resposta. A resposta retorna as Posts que foram recuperadas e, em seguida, define nextToken como a entrada Post logo após o limite. A próxima solicitação é enviada para fazer exatamente a mesma coisa, mas começando pelo deslocamento logo após a primeira consulta. Lembre-se de que esses tipos de solicitações são feitos sequencialmente e não de maneira simultânea.