Abilitazione della compressione del payload per un'API in Gateway API

Puoi abilitare la compressione per un'API utilizzando la console API Gateway AWS CLI, o un AWS SDK.

Per un'API esistente, dopo aver abilitato la compressione, è necessario distribuire l'API per rendere effettiva la modifica. Per una nuova API, puoi distribuirla dopo aver terminato la configurazione.

Nota

La codifica dei contenuti con la massima priorità deve essere supportata da API Gateway. In caso contrario, la compressione non viene applicata al payload della risposta.

Abilitazione della compressione dei payload per un'API mediante la console API Gateway

Nella procedura seguente viene descritto come abilitare la compressione del payload per un'API.

Per abilitare la compressione del payload usando la console API Gateway

1. Accedi alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

2. Seleziona un'API esistente o creane una nuova.

3. Nel riquadro di navigazione principale, scegli Impostazioni API.

4. Nella sezione Dettagli API, scegli Modifica.

5. Attiva l'opzione Codifica contenuto per abilitare la compressione del payload. In Dimensione corpo minima, immetti un numero per la dimensione di compressione minima (in byte). Per disattivare la compressione, disattiva l'opzione Codifica contenuto.

6. Scegli Save changes (Salva modifiche).

Abilita la compressione del payload per un'API utilizzando il AWS CLI

Il create-rest-apicomando seguente crea un'API con compressione del payload:

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

Il update-rest-apicomando seguente abilita la compressione del payload per un'API esistente:

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

La proprietà minimumCompressionSize ha un valore intero non negativo compreso tra 0 e 10485760 (10M byte). Misura la soglia di compressione. Se la dimensione del payload è inferiore a questo valore, la compressione o la decompressione non vengono applicate al payload. Impostando il valore su zero, la compressione viene applicata per qualsiasi dimensione di payload.

Il update-rest-apicomando seguente disattiva la compressione del payload:

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

È anche possibile impostare value su una stringa vuota "" o omettere completamente la proprietà value nella chiamata precedente.

Codifiche di contenuto supportate da API Gateway

API Gateway supporta le codifiche di contenuto seguenti:

• deflate

• gzip

• identity

API Gateway supporta anche il formato di intestazione Accept-Encoding seguente, in base alla specifica 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