Aktifkan kompresi payload untuk API

Anda dapat mengaktifkan kompresi untuk API menggunakan konsol API Gateway, the AWS CLI, atau AWS SDK.

Untuk API yang ada, Anda harus menerapkan API setelah mengaktifkan kompresi agar perubahan diterapkan. Untuk API baru, Anda dapat menerapkan API setelah penyiapan API selesai.

catatan

Pengkodean konten dengan prioritas tertinggi harus didukung oleh API Gateway. Jika tidak, kompresi tidak diterapkan pada muatan respons.

Mengaktifkan kompresi payload untuk API menggunakan konsol API Gateway

Prosedur berikut menjelaskan cara mengaktifkan kompresi payload untuk API.

Untuk mengaktifkan kompresi payload dengan menggunakan konsol API Gateway

1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

2. Pilih API yang sudah ada atau buat yang baru.

3. Di panel navigasi utama, pilih pengaturan API.

4. Di bagian detail API, pilih Edit.

5. Aktifkan pengkodean konten untuk mengaktifkan kompresi muatan. Untuk ukuran tubuh Minimum, masukkan angka untuk ukuran kompresi minimum (dalam byte). Untuk mematikan kompresi, matikan opsi Pengkodean konten.

6. Pilih Simpan perubahan.

Aktifkan kompresi payload untuk API menggunakan AWS CLI

Untuk menggunakan AWS CLI untuk membuat API baru dan mengaktifkan kompresi, panggil create-rest-apiperintah sebagai berikut:

aws apigateway create-rest-api \
    --name "My test API" \
    --minimum-compression-size 0

Untuk menggunakan AWS CLI untuk mengaktifkan kompresi pada API yang ada, panggil update-rest-apiperintah sebagai berikut:

aws apigateway update-rest-api \
    --rest-api-id 1234567890 \
    --patch-operations op=replace,path=/minimumCompressionSize,value=0

minimumCompressionSizeProperti memiliki nilai integer non-negatif antara 0 dan 10485760 (10M byte). Ini mengukur ambang kompresi. Jika ukuran muatan lebih kecil dari nilai ini, kompresi atau dekompresi tidak diterapkan pada muatan. Pengaturan ke nol memungkinkan kompresi untuk ukuran muatan apa pun.

Untuk menggunakan AWS CLI untuk menonaktifkan kompresi, panggil update-rest-apiperintah sebagai berikut:

aws apigateway update-rest-api \
    --rest-api-id 1234567890 \
    --patch-operations op=replace,path=/minimumCompressionSize,value=

Anda juga dapat mengatur value ke string kosong "" atau menghilangkan value properti sama sekali dalam panggilan sebelumnya.

Pengkodean konten yang didukung oleh API Gateway

API Gateway mendukung pengkodean konten berikut:

• deflate

• gzip

• identity

API Gateway juga mendukung format Accept-Encoding header berikut, sesuai dengan spesifikasi RFC 7231:

• Accept-Encoding:deflate,gzip

• Accept-Encoding:

• Accept-Encoding:*

• Accept-Encoding:deflate;q=0.5,gzip;q=1.0

• Accept-Encoding:gzip;q=1.0,identity;q=0.5,*;q=0