Aktivieren der Nutzlastkomprimierung für eine API

Sie können die Komprimierung für eine API mithilfe der API Gateway Gateway-Konsole AWS CLI, des oder eines AWS SDK aktivieren.

Im Fall einer vorhandenen API müssen Sie nach der Aktivierung der Komprimierung die API bereitstellen, damit die Änderungen wirksam werden. Im Fall einer neuen API können Sie die API nach Abschluss der API-Einrichtung bereitstellen.

Anmerkung

Die Inhaltskodierung mit der höchsten Priorität muss von API Gateway unterstützt werden. Wenn dies nicht der Fall ist, wird keine Komprimierung auf die Antwortnutzlast angewendet.

Payload-Komprimierung für eine API über die API Gateway-Konsole aktivieren

Im folgenden Verfahren wird beschrieben, wie Sie die Nutzlastkomprimierung für eine API aktivieren.

So aktivieren Sie die Payload-Komprimierung über die API Gateway-Konsole:

1. Melden Sie sich bei der API-Gateway-Konsole unter https://console.aws.amazon.com/apigateway an.

2. Wählen Sie eine vorhandene API oder erstellen Sie eine neue.

3. Wählen Sie im Hauptnavigationsbereich API-Einstellungen.

4. Wählen Sie im Abschnitt API-Details die Option Bearbeiten aus.

5. Aktivieren Sie die Inhaltskodierung, um die Nutzlast-Komprimierung zu aktivieren. Geben Sie einen Wert für die Mindestkomprimierungsgröße (in Byte) unter Mindesttextgröße ein. Um die Komprimierung zu deaktivieren, schalten Sie die Option Inhaltskodierung aus.

6. Wählen Sie Änderungen speichern aus.

Aktivieren Sie die Payloadkomprimierung für eine API mithilfe von AWS CLI

Rufen Sie den create-rest-apiBefehl wie folgt auf, AWS CLI um eine neue API zu erstellen und die Komprimierung zu aktivieren:

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

Rufen Sie den update-rest-apiBefehl wie folgt auf, AWS CLI um die Komprimierung für eine bestehende API zu aktivieren:

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

Die Eigenschaft minimumCompressionSize weist eine nicht negative ganze Zahl zwischen 0 und 10485760 (10 M Bytes) auf. Mit ihr wird die Komprimierung gemessen. Wenn die Nutzlastgröße kleiner als dieser Wert ist, wird die Komprimierung oder Dekomprimierung nicht auf die Nutzlast angewendet. Wenn er auf Null festgelegt ist, ist die Komprimierung für jede beliebige Nutzlastgröße erlaubt.

Rufen Sie den update-rest-apiBefehl wie folgt auf, AWS CLI um die Komprimierung zu deaktivieren:

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

Sie können value auch auf eine leere Zeichenfolge "" festlegen oder die Eigenschaft value im vorhergehenden Aufruf vollständig weglassen.

Von API Gateway unterstützte Inhaltskodierungen

API Gateway unterstützt die folgenden Inhaltskodierungen:

• deflate

• gzip

• identity

API Gateway unterstützt auch das folgende Accept-Encoding Header-Format gemäß der Spezifikation 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