x-amazon-apigateway-gateway-réponses. responseTemplates objet - APIPasserelle Amazon

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

x-amazon-apigateway-gateway-réponses. responseTemplates objet

Définit les modèles de GatewayResponsemappage, sous forme de string-to-string carte de paires clé-valeur, pour une réponse de passerelle donnée. Pour chaque paire clé-valeur, la clé est le type de contenu. Par exemple, « application/json » et la valeur est un modèle de mappage obtenu à l'aide de stringify pour les substitutions de variables simples. Un modèle de GatewayResponse mappage n'est pas traité par le moteur Velocity Template Language (VTL).

Nom de la propriété Type Description
content-type string

Corps de modèle de mappage GatewayResponse prenant en charge uniquement les substitutions de variables simples pour personnaliser un corps de réponse de passerelle.

x-amazon-apigateway-gateway-réponses. responseTemplates exemple

L'exemple d'APIextensions ouvertes suivant montre un modèle de GatewayResponsemappage permettant de personnaliser une réponse d'erreur API générée par Gateway dans un format spécifique à l'application.

"responseTemplates": { "application/json": "{ \"message\": $context.error.messageString, \"type\":$context.error.responseType, \"statusCode\": '488' }" }

L'exemple d'APIextensions ouvertes suivant montre un modèle de GatewayResponsemappage permettant de remplacer une réponse d'erreur API générée par Gateway par un message d'erreur statique.

"responseTemplates": { "application/json": "{ \"message\": 'API-specific errors' }" }