Abilita la compressione del API payload API per un in Gateway - Amazon API Gateway

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Abilita la compressione del API payload API per un in Gateway

È possibile abilitare la compressione per un API utilizzando la console API Gateway, il AWS CLI, o un AWS SDK.

Per una versione esistenteAPI, è necessario implementare la compressione API dopo aver abilitato la compressione affinché la modifica abbia effetto. Per una nuova versioneAPI, è possibile distribuirla API dopo aver completato la API configurazione.

Nota

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

Abilita la compressione del payload per un utilizzo della console Gateway API API

La procedura seguente descrive come abilitare la compressione del payload per unAPI.

Per abilitare la compressione del payload utilizzando la API console Gateway
  1. Accedere alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

  2. Scegline uno esistente API o creane uno nuovo.

  3. Nel riquadro di navigazione principale, scegli APIimpostazioni.

  4. Nella sezione dei APIdettagli, 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. Seleziona Salvataggio delle modifiche.

Abilita la compressione del payload per un API utilizzo di AWS CLI

Per utilizzare il AWS CLI per creare una nuova compressione API e abilitare la compressione, chiama il create-rest-apicomando come segue:

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

Per utilizzare l'opzione AWS CLI per abilitare la compressione su un sistema esistenteAPI, chiamate il update-rest-apicomando come segue:

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.

Per utilizzare il comando AWS CLI per disabilitare la compressione, chiamate il update-rest-apicomando come segue:

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 dei contenuti supportate da API Gateway

APIGateway supporta le seguenti codifiche di contenuto:

  • deflate

  • gzip

  • identity

APIGateway supporta anche il seguente formato di Accept-Encoding intestazione, in base alla specifica RFC7231:

  • 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