Activer la compression de la charge utile pour une passerelle API intégrée API - APIPasserelle Amazon
Activer la compression de charge utile pour une API utilisation de la console API GatewayActivez la compression de charge utile pour une API utilisation du AWS CLICodages de contenu pris en charge par Gateway API

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.

Activer la compression de la charge utile pour une passerelle API intégrée API

Vous pouvez activer la compression pour un API en utilisant la console API Gateway, le AWS CLI, ou un AWS SDK.

Pour une version existanteAPI, vous devez déployer le API après avoir activé la compression pour que la modification soit prise en compte. Pour un nouveauAPI, vous pouvez le déployer une API fois la API configuration terminée.

Note

Le codage de contenu le plus prioritaire doit être pris en charge par API Gateway. Si ce n'est pas le cas, la compression n'est pas appliquée à la charge utile de la réponse.

Activer la compression de charge utile pour une API utilisation de la console API Gateway

La procédure suivante décrit comment activer la compression de charge utile pour unAPI.

Pour activer la compression de charge utile à l'aide de la console API Gateway

  1. Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.

  2. Choisissez-en un existant API ou créez-en un nouveau.

  3. Dans le volet de navigation principal, choisissez APIles paramètres.

  4. Dans la section des APIdétails, choisissez Modifier.

  5. Activez Encodage de contenu pour activer la compression de la charge utile. Pour Taille minimale du corps, entrez un nombre pour la taille de compression minimale (en octets). Pour désactiver la compression, désactivez l'option Encodage de contenu.

  6. Sélectionnez Enregistrer les modifications.

Activez la compression de charge utile pour une API utilisation du AWS CLI

Pour utiliser le AWS CLI pour créer une nouvelle compression API et l'activer, appelez la create-rest-apicommande comme suit :

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

AWS CLI Pour activer la compression sur un objet existantAPI, appelez la update-rest-apicommande comme suit : 

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

La propriété minimumCompressionSize possède un nombre entier non négatif compris entre 0 et 10485760 (10 Mo). Elle mesure le seuil de compression. Si la taille de charge est inférieure à cette valeur, la compression ou décompression ne sont pas appliquées sur la charge utile. La définition de l'option sur zéro permet la compression de n'importe quelle taille de charge utile.

AWS CLI Pour désactiver la compression, appelez la update-rest-apicommande comme suit : 

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

Vous pouvez également définir value sur une chaîne vide "" ou omettez la propriété value complètement dans l'appel précédent.

Codages de contenu pris en charge par Gateway API

APIGateway prend en charge les codages de contenu suivants :

  • deflate

  • gzip

  • identity

APIGateway prend également en charge le format Accept-Encoding d'en-tête suivant, conformément à la spécification 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