Compressione del payload per REST APIs in API Gateway

APIGateway consente al cliente di chiamarvi API con payload compressi utilizzando una delle codifiche di contenuto supportate. Per impostazione predefinita, API Gateway supporta la decompressione del payload di richiesta del metodo. Tuttavia, è necessario configurare in modo API da abilitare la compressione del payload del metodo di risposta.

Per abilitare la compressione su un API, impostate la minimumCompressionsSizeproprietà su un numero intero non negativo compreso tra 0 e 10485760 (10 milioni di byte) quando create o dopo aver creato il. API API Per disabilitare la compressione suAPI, impostatela su null o rimuovetela del tuttominimumCompressionSize. È possibile abilitare o disabilitare la compressione per un API utilizzando la console API Gateway, il o il AWS CLI Gateway. API REST API

Se desideri che la compressione venga applicata a payload di qualsiasi dimensione, imposta il valore di minimumCompressionSize su zero. La compressione di dati di piccole dimensioni può tuttavia comportare un aumento della dimensione finale dei dati. Inoltre, la compressione in API Gateway e la decompressione nel client potrebbero aumentare la latenza complessiva e richiedere più tempi di elaborazione. È necessario eseguire dei test case con il proprio API per determinare un valore ottimale.

Il client può inviare una API richiesta con un payload compresso e un'Content-Encodingintestazione appropriata per consentire a API Gateway di decomprimere e applicare i modelli di mappatura applicabili, prima di passare la richiesta all'endpoint di integrazione. Dopo aver abilitato la compressione e implementata, API il client può ricevere una API risposta con un payload compresso se specifica un'intestazione appropriata nella richiesta del metodo. Accept-Encoding

Quando l'endpoint di integrazione prevede e restituisce payload non compressi, qualsiasi modello di mappatura configurato per un JSON payload non compresso è applicabile al payload compresso. JSON Per un payload di richiesta con metodo compresso, API Gateway decomprime il payload, applica il modello di mappatura e passa la richiesta mappata all'endpoint di integrazione. Per un payload di risposta di integrazione non compresso, API Gateway applica il modello di mappatura, comprime il payload mappato e restituisce il payload compresso al client.