Compression de charge utile pour REST APIs dans Gateway API - APIPasserelle Amazon

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Compression de charge utile pour REST APIs dans Gateway API

APIGateway permet à votre client de vous appeler API avec des charges utiles compressées en utilisant l'un des codages de contenu pris en charge. Par défaut, API Gateway prend en charge la décompression de la charge utile de la demande de méthode. Cependant, vous devez configurer votre API pour activer la compression de la charge utile de réponse de la méthode.

Pour activer la compression sur un API, définissez la minimumCompressionsSizepropriété sur un entier non négatif compris entre 0 et 10485760 (10 millions d'octets) lorsque vous créez le API ou après avoir créé le. API Pour désactiver la compression sur leAPI, définissez le minimumCompressionSize sur null ou supprimez-le complètement. Vous pouvez activer ou désactiver la compression pour un en API utilisant la console API Gateway AWS CLI, le ou le API Gateway RESTAPI.

Si vous souhaitez que la compression soit appliquée sur une charge utile de n'importe quelle taille, définissez la valeur minimumCompressionSize sur zéro. Toutefois, la compression des données de petite taille peut augmenter la taille des données finales. En outre, la compression dans API Gateway et la décompression dans le client peuvent augmenter la latence globale et nécessiter plus de temps de calcul. Vous devez exécuter des tests par rapport API à votre pour déterminer une valeur optimale.

Le client peut soumettre une API demande avec une charge utile compressée et un Content-Encoding en-tête approprié pour que API Gateway puisse décompresser et appliquer les modèles de mappage applicables, avant de transmettre la demande au point de terminaison d'intégration. Une fois la compression activée et API déployée, le client peut recevoir une API réponse avec une charge utile compressée s'il spécifie un Accept-Encoding en-tête approprié dans la demande de méthode.

Lorsque le point de terminaison d'intégration attend et renvoie des JSON charges utiles non compressées, tout modèle de mappage configuré pour une charge utile non compressée est applicable à la JSON charge utile compressée. Pour une charge utile de demande de méthode compressée, API Gateway décompresse la charge utile, applique le modèle de mappage et transmet la demande mappée au point de terminaison d'intégration. Pour une charge utile de réponse d'intégration non compressée, API Gateway applique le modèle de mappage, compresse la charge utile mappée et renvoie la charge utile compressée au client.