JavaScript Resolver-Funktionsreferenz für HTTP

Mit den AWS AppSync HTTP Resolver-Funktionen können Sie Anfragen von AWS AppSync einem beliebigen HTTP Endpunkt und Antworten von Ihrem HTTP Endpunkt zurück an diesen senden. AWS AppSync Mit Ihrem Request-Handler können Sie AWS AppSync Hinweise zur Art des aufzurufenden Vorgangs geben. In diesem Abschnitt werden die verschiedenen Konfigurationen für den unterstützten HTTP Resolver beschrieben.

Anforderung

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

Der folgende Ausschnitt ist ein Beispiel für eine HTTP POST Anfrage mit einem Hauptteil: text/plain

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

Methode

Anmerkung

Dies gilt nur für den Request-Handler.

HTTPMethode oder Verb (GET,POST, PUTPATCH, oderDELETE), das AWS AppSync an den HTTP Endpunkt sendet.

"method": "PUT"

ResourcePath

Anmerkung

Dies gilt nur für den Request-Handler.

Der Ressourcenpfad, auf den Sie zugreifen möchten. Zusammen mit dem Endpunkt in der HTTP Datenquelle bildet der Ressourcenpfad denURL, an den der AWS AppSync Dienst eine Anfrage stellt.

"resourcePath": "/v1/users"

Wenn die Anfrage ausgewertet wird, wird dieser Pfad als Teil der HTTP Anfrage gesendet, einschließlich des HTTP Endpunkts. Das vorherige Beispiel kann dann beispielsweise so aussehen:

PUT <endpoint>/v1/users

Params-Felder

Anmerkung

Dies gilt nur für den Request-Handler.

Wird verwendet, um anzugeben, welche Aktion die Suche durchführt, meistens indem der Abfragewert im Body festgelegt wird. Es gibt jedoch einige andere Funktionen, die konfiguriert werden können, wie z. B. die Formatierung von Antworten.

Header

Die Header-Informationen, wie beispielsweise Schlüssel-Wert-Paare. Der Schlüssel und der Wert müssen beide Strings sein.

Beispielsweise:

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

Derzeit werden folgende Content-Type-Header unterstützt:

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

Sie können die folgenden HTTP Header nicht festlegen:

HOST
CONNECTION
USER-AGENT
EXPECTATION
TRANSFER_ENCODING
CONTENT_LENGTH

query

Schlüssel-Wert-Paare, die allgemeine Optionen angeben, z. B. die Codeformatierung für Antworten. JSON Der Schlüssel und der Wert müssen beide Strings sein. Das folgende Beispiel zeigt, wie Sie eine Abfragezeichenfolge als ?type=json senden können:

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

body

Der Hauptteil enthält den HTTP Anfragetext, den Sie festlegen möchten. Der Anforderungstext ist immer eine mit UTF -8 kodierte Zeichenfolge, es sei denn, der Inhaltstyp spezifiziert den Zeichensatz.

"body":"body string"

Antwort

Sehen Sie ein Beispiel hier.