Activation de la compression des données utiles pour une API dans API Gateway

Vous pouvez activer la compression pour une API à l'aide de la console API Gateway AWS CLI, du ou d'un AWS SDK.

Pour une API existante, vous devez déployer l’API après avoir activé la compression pour que la modification entre en vigueur. Pour une nouvelle API, vous pouvez déployer l’API une fois sa configuration terminée.

Note

La priorité d’encodage de contenu la plus élevée doit être prise 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.

Activation de la compression de charge utile pour une API à l’aide de la console API Gateway

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

Pour activer la compression de la 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 une API existante ou créez-en une.

3. Dans le panneau de navigation principal, choisissez Paramètres de l’API.

4. Dans la section Détails de l’API, 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 à l'aide du AWS CLI

La create-rest-apicommande suivante crée une API avec compression de charge utile :

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

La update-rest-apicommande suivante active la compression de charge utile pour une API existante :

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.

La update-rest-apicommande suivante désactive la compression de la charge utile :

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 API Gateway

API Gateway prend en charge les codages de contenu suivants :

• deflate

• gzip

• identity

API Gateway prend également en charge le format d’en-tête Accept-Encoding suivant, conformément à la spécification RFC 7231 :

• 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