Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Menggunakan template pemetaan untuk mengganti parameter permintaan dan respons API serta kode status
Parameter API Gateway standar dan templat pemetaan kode respons memungkinkan Anda memetakan parameter one-to-one dan memetakan keluarga kode status respons integrasi, yang dicocokkan dengan ekspresi reguler, ke kode status respons tunggal. Pemetaan penggantian template memungkinkan Anda melakukan hal berikut.
-
Lakukan pemetaan many-to-one parameter
-
Ganti parameter setelah pemetaan API Gateway standar diterapkan
-
Parameter peta kondisional berdasarkan konten tubuh atau nilai parameter lainnya
-
Buat parameter baru secara terprogram
-
Ganti kode status yang dikembalikan oleh titik akhir integrasi Anda
Semua jenis parameter permintaan, header respons, atau kode status respons dapat diganti.
Kasus penggunaan untuk mengganti parameter permintaan dan respons API serta kode status
Di API Anda, Anda dapat menggunakan penggantian template pemetaan untuk API Anda untuk melakukan hal berikut.
-
Untuk membuat header baru (atau menimpa header yang ada) sebagai gabungan dari dua parameter
-
Untuk mengganti kode respons ke kode sukses atau gagal berdasarkan isi tubuh
-
Untuk memetakan ulang parameter secara kondisional berdasarkan isinya atau isi dari beberapa parameter lainnya
-
Untuk mengulangi konten badan json dan memetakan ulang pasangan nilai kunci ke header atau string kueri
Pertimbangan untuk mengesampingkan parameter permintaan dan respons API serta kode status
Pertimbangan berikut dapat memengaruhi penggunaan penggantian template pemetaan Anda.
-
Penggantian template pemetaan tidak dapat digunakan dengan titik akhir integrasi proxy, yang tidak memiliki pemetaan data. Untuk informasi selengkapnya tentang jenis integrasi, lihatPilih jenis integrasi API Gateway API.
-
Override adalah final. Override hanya dapat diterapkan ke setiap parameter satu kali. Jika Anda mencoba mengganti parameter yang sama beberapa kali, API Gateway mengembalikan
5XXrespons. Jika Anda harus mengganti parameter yang sama beberapa kali di seluruh template, kami sarankan membuat variabel dan menerapkan override di akhir template. Template diterapkan hanya setelah seluruh template diurai. Untuk informasi selengkapnya, silakan lihat Ganti parameter permintaan API dan header menggunakan AWS Management Console
Referensi penggantian template pemetaan
Untuk membuat penggantian template pemetaan, gunakan satu atau beberapa $contextvariabel berikut dalam templat pemetaan:
| Minta templat pemetaan tubuh | Templat pemetaan tubuh respons |
|---|---|
$context.requestOverride.header. |
$context.responseOverride.header. |
$context.requestOverride.path. |
$context.responseOverride.status |
$context.requestOverride.querystring. |
Tidak ada |
Untuk contoh penggantian parameter permintaan dan respons API serta kode status, lihatContoh penggantian parameter permintaan dan respons API serta kode status.
