Kompresi muatan untuk REST APIs di API Gateway

APIGateway memungkinkan klien Anda untuk memanggil Anda API dengan muatan terkompresi dengan menggunakan salah satu pengkodean konten yang didukung. Secara default, API Gateway mendukung dekompresi payload permintaan metode. Namun, Anda harus mengonfigurasi API untuk mengaktifkan kompresi payload respons metode.

Untuk mengaktifkan kompresi pada API, atur minimumCompressionsSizeproperti ke bilangan bulat non-negatif antara 0 dan 10485760 (10M byte) saat Anda membuat atau setelah Anda membuat file. API API Untuk menonaktifkan kompresi padaAPI, atur minimumCompressionSize ke null atau hapus sama sekali. Anda dapat mengaktifkan atau menonaktifkan kompresi untuk API dengan menggunakan konsol API Gateway, the AWS CLI, atau API Gateway RESTAPI.

Jika Anda ingin kompresi diterapkan pada muatan dari berbagai ukuran, atur minimumCompressionSize nilainya ke nol. Namun, mengompresi data dengan ukuran kecil sebenarnya dapat meningkatkan ukuran data akhir. Selain itu, kompresi di API Gateway dan dekompresi pada klien dapat meningkatkan latensi keseluruhan dan membutuhkan lebih banyak waktu komputasi. Anda harus menjalankan kasus uji terhadap Anda API untuk menentukan nilai optimal.

Klien dapat mengirimkan API permintaan dengan muatan terkompresi dan Content-Encoding header yang sesuai untuk API Gateway untuk mendekompresi dan menerapkan templat pemetaan yang berlaku, sebelum meneruskan permintaan ke titik akhir integrasi. Setelah kompresi diaktifkan dan API dikerahkan, klien dapat menerima API respons dengan muatan terkompresi jika menentukan Accept-Encoding header yang sesuai dalam permintaan metode.

Saat titik akhir integrasi mengharapkan dan mengembalikan muatan yang tidak terkompresi, templat pemetaan apa pun yang dikonfigurasi untuk JSON muatan yang tidak terkompresi berlaku untuk muatan terkompresiJSON. Untuk payload permintaan metode terkompresi, API Gateway mendekompresi payload, menerapkan template pemetaan, dan meneruskan permintaan yang dipetakan ke titik akhir integrasi. Untuk muatan respons integrasi yang tidak terkompresi, API Gateway menerapkan template pemetaan, mengompres muatan yang dipetakan, dan mengembalikan muatan terkompresi ke klien.