View a markdown version of this page

Objek x-amazon-apigateway-gateway-responses.gatewayResponse - Amazon API Gateway
Contoh x-amazon-apigateway-gateway-responses.gatewayResponse

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

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

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

Nama properti Tipe Deskripsi
responseParameters X-amazon-apigateway-gateway-responses.responseParameters

Menentukan GatewayResponse parameter, 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 respons gateway. Template tidak diproses oleh mesin VTL.
statusCode string

Kode status HTTP untuk respon gateway.

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

Contoh ekstensi API Gateway ke OpenAPI berikut mendefinisikan a GatewayResponse untuk menyesuaikan INVALID_API_KEY respons untuk mengembalikan kode status456, nilai api-key header permintaan masuk, dan "Bad api-key" pesan. 


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