Oggetto x-amazon-apigateway-gateway-responses.gatewayResponse - Amazon API Gateway
Esempio di x-amazon-apigateway-gateway-responses.gatewayResponse

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

Definisce una risposta del gateway di un tipo di risposta specificato, inclusi il codice di stato, eventuali modelli di risposta o parametri di risposta applicabili.

Nome proprietà Tipo Descrizione
responseParameters x-amazon-apigateway-gateway-responses.responseParameters

Specifica i parametri GatewayResponse, ovvero i parametri di intestazione. I valori di parametro possono assumere qualsiasi valore di parametro di richiesta in ingresso o un valore personalizzato statico.
responseTemplates x-amazon-apigateway-gateway-responses.responseTemplates

Specifica i modelli di mappatura della risposta del gateway. I modelli non sono elaborati dal motore VTL.
statusCode string

Un codice di stato HTTP per la risposta del gateway.

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

L'esempio seguente dell'estensione API Gateway in OpenAPI definisce un'istanza di GatewayResponse per personalizzare la risposta INVALID_API_KEY per restituire il codice di stato 456, il valore di intestazione api-key della richiesta in ingresso e un messaggio "Bad api-key". 


    "INVALID_API_KEY": {
      "statusCode": "456",
      "responseParameters": {
        "gatewayresponse.header.api-key": "method.request.header.api-key"
      },
      "responseTemplates": {
        "application/json": "{\"message\": \"Bad api-key\" }"
      }
    }