View a markdown version of this page

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

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

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

Definisce i modelli di GatewayResponse mappatura, come una mappa da stringa a stringa di coppie chiave-valore, per una determinata risposta del gateway. Per ogni coppia chiave-valore, la chiave è il tipo di contenuto. Ad esempio, application/json "e il valore è un modello di mappatura stringato per semplici sostituzioni di variabili. Un modello di mappatura GatewayResponse non viene elaborato dal motore Velocity Template Language (VTL).

Nome proprietà Tipo Descrizione
content-type string

Modello di mappatura del corpo GatewayResponse che supporta solo la semplice sostituzione di variabili per personalizzare un corpo della risposta del gateway.

Esempio di x-amazon-apigateway-gateway-responses.responseTemplates

Il seguente esempio di estensioni OpenAPI mostra un modello di GatewayResponse mappatura per personalizzare una risposta di errore generata da API Gateway in un formato specifico dell'app.

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

Il seguente esempio di estensioni OpenAPI mostra un modello di GatewayResponse mappatura per sovrascrivere una risposta di errore generata da API Gateway con un messaggio di errore statico.

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