View a markdown version of this page

objek x-amazon-apigateway-integration.response - Amazon API Gateway
contoh x-amazon-apigateway-integration.response

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

objek x-amazon-apigateway-integration.response

Mendefinisikan respons dan menentukan pemetaan parameter atau pemetaan muatan dari respons integrasi ke respons metode.

Nama properti Tipe Deskripsi
statusCode string

Kode status HTTP untuk respons metode; misalnya,"200". Ini harus sesuai dengan respons yang cocok di responses bidang Oper asi OpenAPI.
responseTemplates Objek x-amazon-apigateWay-Integration.ResponseTemplates

Menentukan template pemetaan khusus tipe MIME untuk payload respons.
responseParameters Objek x-amazon-apigateWay-Integration.ResponseParameters

Menentukan pemetaan parameter untuk respons. Hanya body parameter header dan dari respons integrasi yang dapat dipetakan ke header parameter metode.

contentHandling string Jenis konversi pengkodean payload respons. Nilai yang valid adalah 1)CONVERT_TO_TEXT, untuk mengubah payload biner menjadi string yang dikodekan base64 atau mengubah payload teks menjadi string yang utf-8 dikodekan atau melewati muatan teks secara asli tanpa modifikasi, dan 2)CONVERT_TO_BINARY, untuk mengubah payload teks menjadi blob yang didekode base64 atau melewati payload biner secara asli tanpa modifikasi.

contoh x-amazon-apigateway-integration.response

Contoh berikut mendefinisikan 302 respons untuk metode yang memperoleh payload dari jenis application/json atau application/xml MIME dari backend. Respons menggunakan template pemetaan yang disediakan dan mengembalikan URL pengalihan dari respons integrasi di Location header metode. 


{
    "statusCode" : "302",
    "responseTemplates" : {
         "application/json" : "#set ($root=$input.path('$')) { \"stage\": \"$root.name\", \"user-id\": \"$root.key\" }",
         "application/xml" : "#set ($root=$input.path('$')) <stage>$root.name</stage> "
    },
    "responseParameters" : {
        "method.response.header.Location": "integration.response.body.redirect.url"
    }
}