Référence du modèle de mappage des résolveurs pour HTTP

LeAWSLes modèles de mappage du résolveur HTTP AppSync vous permettent d'envoyer des demandes depuisAWSAppSync vers n'importe quel point de terminaison HTTP, et des réponses depuis votre point de terminaison HTTP en retour versAWSAppSync. En utilisant les modèles de mappage, vous pouvez donner des conseils pourAWSAppSync pour sur la nature de l'opération à appeler. Cette section décrit les différents modèles de mappage pour le résolveur HTTP pris en charge.

Modèle de mappage de demande

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

Une fois le modèle de mappage de demande HTTP résolu, la représentation du schéma JSON du modèle de mappage de demande ressemble à ce qui suit :

{
    "$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"
    ]
}

Voici un exemple de demande HTTP POST, avec un corps text/plain :

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

Version

Modèle de mappage de demande uniquement

Définit la version utilisée par le modèle. version est commun à tous les modèles de mappage de demande et obligatoire.

"version": "2018-05-29"

Méthode

Modèle de mappage de demande uniquement

Méthode ou verbe HTTP (GET, POST, PUT, PATCH ou DELETE)AWSAppSync envoie au point de terminaison HTTP.

"method": "PUT"

Chemin de la ressource

Modèle de mappage de demande uniquement

Chemin de la ressource à laquelle vous souhaitez accéder. Avec le point de terminaison dans la source de données HTTP, le chemin de la ressource constitue l'URL à laquelleAWSLe service AppSync fait une demande à.

"resourcePath": "/v1/users"

Lorsque le modèle de mappage est évalué, ce chemin est envoyé dans le cadre de la demande HTTP, y compris le point de terminaison HTTP. Ainsi, l'exemple précédent pourrait donner :

PUT <endpoint>/v1/users

Champ Params

Modèle de mappage de demande uniquement

Permet de spécifier l'action exécutée par votre recherche, plus couramment en définissant la valeur de query à l'intérieur de la section body. Toutefois, il existe plusieurs autres capacités qui peuvent être configurées, comme la mise en forme des réponses.

headers

Informations d'en-tête, sous forme de paires clé-valeur. La clé et la valeur doivent être des chaînes.

Par Exemple:

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

Les en-têtes Content-Type actuellement pris en charge sont les suivants :

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

Remarque : Vous ne pouvez pas définir les en-têtes HTTP suivants :

HOST
CONNECTION
USER-AGENT
EXPECTATION
TRANSFER_ENCODING
CONTENT_LENGTH

query

Paires clé-valeur qui spécifient les options courantes, telles que la mise en forme du code pour les réponses JSON. La clé et la valeur doivent être une chaîne. L'exemple suivant montre comment envoyer une chaîne de requête comme ?type=json :

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

body

Le corps contient le corps de la demande HTTP que vous choisissez de définir. Le corps de la demande est toujours une chaîne encodée en UTF-8, sauf si le type de contenu spécifie le jeu de caractères.

"body":"body string"