AWS AppSync Referenz zur Resolver-Mapping-Vorlage für HTTP

Anmerkung

Wir unterstützen jetzt hauptsächlich die APPSYNC _JS-Laufzeit und ihre Dokumentation. Bitte erwägen Sie, die APPSYNC _JS-Laufzeit und ihre Anleitungen hier zu verwenden.

Mit den AWS AppSync HTTP Resolver-Mapping-Vorlagen können Sie Anfragen von jedem HTTP Endpunkt aus AWS AppSync senden und Antworten von Ihrem HTTP Endpunkt zurück an. AWS AppSync Mithilfe von Zuordnungsvorlagen können Sie AWS AppSync Hinweise zur Art des aufzurufenden Vorgangs geben. In diesem Abschnitt werden die verschiedenen Zuordnungsvorlagen für den unterstützten HTTP Resolver beschrieben.

Mapping-Vorlage anfordern

{
    "version": "2018-05-29",
    "method": "PUT|POST|GET|DELETE|PATCH",
    "params": {
        "query": Map,
        "headers": Map,
        "body": any
    },
    "resourcePath": string
}

Nachdem die Vorlage für die HTTP Anforderungszuweisung aufgelöst wurde, sieht die JSON Schemadarstellung der Vorlage für die Anforderungszuweisung wie folgt aus:

{
    "$id": "https://aws.amazon.com/appsync/request-mapping-template.json",
    "type": "object",
    "properties": {
        "version": {
        "$id": "/properties/version",
        "type": "string",
        "title": "The Version Schema ",
        "default": "",
        "examples": [
            "2018-05-29"
        ],
        "enum": [
            "2018-05-29"
        ]
        },
        "method": {
        "$id": "/properties/method",
        "type": "string",
        "title": "The Method Schema ",
        "default": "",
        "examples": [
            "PUT|POST|GET|DELETE|PATCH"
        ],
        "enum": [
            "PUT",
            "PATCH",
            "POST",
            "DELETE",
            "GET"
        ]
        },
        "params": {
        "$id": "/properties/params",
        "type": "object",
        "properties": {
            "query": {
            "$id": "/properties/params/properties/query",
            "type": "object"
            },
            "headers": {
            "$id": "/properties/params/properties/headers",
            "type": "object"
            },
            "body": {
            "$id": "/properties/params/properties/body",
            "type": "string",
            "title": "The Body Schema ",
            "default": "",
            "examples": [
                ""
            ]
            }
        }
        },
        "resourcePath": {
        "$id": "/properties/resourcePath",
        "type": "string",
        "title": "The Resourcepath Schema ",
        "default": "",
        "examples": [
            ""
        ]
        }
    },
    "required": [
        "version",
        "method",
        "resourcePath"
    ]
}

Im Folgenden finden Sie ein Beispiel für eine HTTP POST Anfrage mit einem text/plain Hauptteil:

{
    "version": "2018-05-29",
    "method": "POST",
    "params": {
        "headers":{
        "Content-Type":"text/plain"
        },
        "body":"this is an example of text body"
    },
    "resourcePath": "/"
}

Version

Anmerkung

Dies gilt nur für die Vorlage zur Anforderungszuweisung.

Definiert die Version, die von der Vorlage verwendet wird. version ist allen Anforderungszuweisungsvorlagen gemeinsam und erforderlich.

"version": "2018-05-29"

Methode

Anmerkung

Dies gilt nur für die Vorlage für die Anforderungszuweisung.

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

"method": "PUT"

ResourcePath

Anmerkung

Dies gilt nur für die Vorlage für die Anforderungszuweisung.

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 Zuordnungsvorlage ausgewertet wird, wird dieser Pfad zusammen mit dem HTTP Endpunkt als Teil der HTTP Anfrage gesendet. Das vorherige Beispiel kann dann beispielsweise so aussehen:

PUT <endpoint>/v1/users

Params-Felder

Anmerkung

Dies gilt nur für die Vorlage für die Zuordnung von Anfragen.

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

Hinweis: 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.