x-amazon-apigateway-gateway-tanggapan. gatewayResponse objek - APIGerbang Amazon

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

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

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

Nama properti Tipe Deskripsi
responseParameters x-amazon-apigateway-gateway-tanggapan. responseParameters

Menentukan GatewayResponseparameter, yaitu parameter header. Nilai parameter dapat mengambil nilai parameter permintaan masuk atau nilai kustom statis.

responseTemplates x-amazon-apigateway-gateway-tanggapan. responseTemplates

Menentukan template pemetaan respon gateway. Template tidak diproses oleh VTL mesin.

statusCode string

Kode HTTP status untuk respons gateway.

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

Contoh berikut dari ekstensi API Gateway ke Open API mendefinisikan 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\" }" } }