View a markdown version of this page

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

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.responseTemplates

Mendefinisikan template GatewayResponse pemetaan, sebagai peta string-ke-string dari pasangan kunci-nilai, untuk respons gateway yang diberikan. Untuk setiap pasangan kunci-nilai, kuncinya adalah jenis konten. Misalnya, "application/json" dan nilainya adalah template pemetaan berstring untuk substitusi variabel sederhana. Template pem GatewayResponse etaan tidak diproses oleh mesin Velocity Template Language (VTL).

Nama properti Tipe Deskripsi
content-type string

Template pemetaan GatewayResponse tubuh yang hanya mendukung substitusi variabel sederhana untuk menyesuaikan badan respons gateway.

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

Contoh ekstensi OpenAPI berikut menunjukkan template pem GatewayResponse etaan untuk menyesuaikan respons kesalahan yang dihasilkan API Gateway ke dalam format khusus aplikasi.

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

Contoh ekstensi OpenAPI berikut menunjukkan template pem GatewayResponse etaan untuk mengganti respons kesalahan yang dihasilkan gateway API dengan pesan kesalahan statis.

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