JavaScript referência da função resolvedor para HTTP

As funções do AWS AppSync HTTP resolvedor permitem que você envie solicitações AWS AppSync de qualquer HTTP endpoint e respostas de seu HTTP endpoint de volta para. AWS AppSync Com seu manipulador de solicitações, você pode fornecer dicas AWS AppSync sobre a natureza da operação a ser invocada. Esta seção descreve as diferentes configurações do HTTP resolvedor compatível.

Solicitação

type HTTPRequest = {
  method: 'PUT' | 'POST' | 'GET' | 'DELETE' | 'PATCH';
  params?: {
    query?: { [key: string]: any };
    headers?: { [key: string]: string };
    body?: any;
  };
  resourcePath: string;
};

O trecho a seguir é um exemplo de uma HTTP POST solicitação, com um text/plain corpo:

export function request(ctx) {
  return {
    method: 'POST',
    params: {
      headers: { 'Content-Type': 'text/plain' },
      body: 'this is an example of text body',
    },
    resourcePath: '/',
  };
}

Método

nota

Isso se aplica somente ao manipulador de solicitações.

HTTPmétodo ou verbo (GET,POST, PUTPATCH, ouDELETE) que AWS AppSync envia para o ponto HTTP final.

"method": "PUT"

ResourcePath

nota

Isso se aplica somente ao manipulador de solicitações.

O caminho do recurso que você deseja acessar. Junto com o endpoint na fonte de HTTP dados, o caminho do recurso forma URL aquele para o qual o AWS AppSync serviço faz uma solicitação.

"resourcePath": "/v1/users"

Quando a solicitação é avaliada, esse caminho é enviado como parte da HTTP solicitação, incluindo o HTTP endpoint. Por exemplo, o exemplo anterior pode ser traduzido para o seguinte:

PUT <endpoint>/v1/users

Campos de parâmetros

nota

Isso se aplica somente ao manipulador de solicitações.

Usado para especificar qual ação é executada pela pesquisa, geralmente definindo o valor consulta dentro do corpo. No entanto, existem vários outros recursos que podem ser configurados, como a formatação de respostas.

headers

As informações do cabeçalho, como pares de chave/valor. A chave e o valor devem ser strings.

Por exemplo: .

"headers" : {
    "Content-Type" : "application/json"
}

Atualmente, os cabeçalhos Content-Type compatíveis são:

text/*
application/xml
application/json
application/soap+xml
application/x-amz-json-1.0
application/x-amz-json-1.1
application/vnd.api+json
application/x-ndjson

Você não pode definir os seguintes HTTP cabeçalhos:

HOST
CONNECTION
USER-AGENT
EXPECTATION
TRANSFER_ENCODING
CONTENT_LENGTH

query

Pares de valores-chave que especificam opções comuns, como formatação de código para respostas. JSON A chave e o valor devem ser strings. O exemplo a seguir mostra como enviar uma string de consulta como ?type=json:

"query" : {
    "type" : "json"
}

body

O corpo contém o corpo da HTTP solicitação que você escolheu definir. O corpo da solicitação é sempre uma string codificada em UTF -8, a menos que o tipo de conteúdo especifique o conjunto de caracteres.

"body":"body string"

Resposta

Veja um exemplo aqui.