x-amazon-apigateway-gateway-Responses.gatewayResponse objek

Mendefinisikan respons gateway dari jenis respons tertentu, termasuk kode status, parameter respons apa pun yang berlaku, atau templat respons.

Properti
Nama properti	Tipe	Deskripsi
responseParameters	x-amazon-apigateway-gateway-Responses.ResponseParameters	Menentukan GatewayResponseparameter, yaitu parameter header. Nilai parameter dapat mengambil nilai parameter permintaan masuk atau nilai kustom statis.
responseTemplates	x-amazon-apigateway-gateway-Responses.ResponseTemplates	Menentukan template pemetaan dari respon gateway. Template tidak diproses oleh mesin VTL.
statusCode	string	Kode status HTTP untuk respons gateway.

x-amazon-apigateway-gateway-Responses.gatewayResponse contoh

Contoh berikut dari ekstensi API Gateway ke OpenAPI mendefinisikan a GatewayResponseuntuk menyesuaikan INVALID_API_KEY respons untuk mengembalikan kode status456, nilai api-key header permintaan masuk, dan pesan. "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\" }"
      }
    }