View a markdown version of this page

Objet x-amazon-apigateway-gateway-responses.responseTemplates - Amazon API Gateway

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.

Objet x-amazon-apigateway-gateway-responses.responseTemplates

Définit les modèles de GatewayResponse mappage, sous la forme d'une carte chaîne à chaîne 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 stringifié pour des substitutions de variables simples. Un modèle de mappage GatewayResponse n’est pas traité par le moteur VTL (Velocity Template Language).

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.

Exemple x-amazon-apigateway-gateway-responses.responseTemplates

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

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

L'exemple d'extensions OpenAPI suivant montre un modèle de GatewayResponse mappage permettant de remplacer une réponse d'erreur générée par API Gateway par un message d'erreur statique.

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