Activation de la compression de la charge utile pour une API - Amazon API Gateway

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.

Activation de la compression de la charge utile pour une API

API Gateway permet au client d'appeler votre API avec des charges utiles compressées à l'aide de 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 la réponse de la méthode.

Pour activer la compression sur une API, définissez la propriété minimumCompressionsSize sur un nombre entier positif compris entre 0 et 10485760 (10 Mo) lorsque vous créez l'API ou une fois que vous l'avez créée. Pour désactiver la compression sur l'API, définissez l'attribut minimumCompressionSize sur null ou supprimez-le complètement. Vous pouvez activer ou désactiver la compression pour une API à l'aide de la console API Gateway, de la AWS CLI ou de l'API REST API Gateway.

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 accroître la latence globale et nécessitent plus de temps de calcul. Vous devez exécuter des tests par rapport à vos API afin de déterminer une valeur optimale.

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

Lorsque le point de terminaison d'intégration attend et renvoie des charges utiles JSON non compressées, les modèles de mappage qui sont configurés pour une charge utile JSON non compressée sont applicables à la charge utile compressée. Pour la charge utile d'une 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 la charge utile d'une 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.