JavaScript referencia de la función de resolución para HTTP

Las AWS AppSync HTTP funciones de resolución le permiten enviar solicitudes desde AWS AppSync cualquier HTTP punto final y respuestas desde su HTTP punto final a AWS AppSync. Con su gestor de solicitudes, puede proporcionar sugerencias AWS AppSync sobre la naturaleza de la operación que se va a invocar. En esta sección se describen las diferentes configuraciones del HTTP solucionador compatible.

Solicitud

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

El siguiente fragmento es un ejemplo de una HTTP POST solicitud, con un text/plain cuerpo:

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

Esto solo se aplica al controlador de solicitudes.

HTTPmétodo o verbo (GET,, POST PUTPATCH, oDELETE) que se AWS AppSync envía al punto finalHTTP.

"method": "PUT"

ResourcePath

nota

Esto solo se aplica al controlador de solicitudes.

La ruta de recurso a la que desea acceso. Junto con el punto final de la fuente de HTTP datos, la ruta del recurso constituye la ruta a la URL que el AWS AppSync servicio realiza la solicitud.

"resourcePath": "/v1/users"

Cuando se evalúa la solicitud, esta ruta se envía como parte de la HTTP solicitud, incluido el HTTP punto final. Por ejemplo, el ejemplo anterior puede convertirse como:

PUT <endpoint>/v1/users

Campos de parámetros

nota

Esto se aplica solo al controlador de solicitudes.

Se utiliza para especificar la acción que realiza la búsqueda, normalmente estableciendo el valor query dentro de body. Sin embargo, se pueden configurar otras funcionalidades, como, por ejemplo, el formato de las respuestas.

headers

Es la información del encabezado en forma de pares clave-valor. Tanto la clave como el valor deben ser cadenas.

Por ejemplo:

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

Los encabezados Content-Type admitidos actualmente son:

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

No puedes configurar los siguientes HTTP encabezados:

HOST
CONNECTION
USER-AGENT
EXPECTATION
TRANSFER_ENCODING
CONTENT_LENGTH

consulta

Pares clave-valor que especifican opciones comunes, como el formato de código para las respuestas. JSON Tanto la clave como el valor deben ser cadenas. En el siguiente ejemplo se muestra el modo de enviar una cadena de consulta como ?type=json:

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

body

El cuerpo contiene el cuerpo de la HTTP solicitud que usted decida establecer. El cuerpo de la solicitud es siempre una cadena codificada en UTF -8, a menos que el tipo de contenido especifique el juego de caracteres.

"body":"body string"

Respuesta

Puede ver un ejemplo aquí.