Aktivieren der Nutzlastkomprimierung für eine API
API Gateway ermöglicht es Ihrem Client, über eine der unterstützten Inhaltskodierungen Ihre API mit komprimierten Payloads aufzurufen. API Gateway unterstützt standardmäßig die Dekomprimierung der Methodenanforderungsnutzlast. Sie müssen Ihre API allerdings so konfigurieren, dass die Komprimierung der Methodenantwortnutzlast aktiviert wird.
Zum Aktivieren der Komprimierung für eine API legen Sie für die Eigenschaft minimumCompressionsSize beim oder nach dem Erstellen der API eine nicht negative Ganzzahl zwischen 0 und 10485760 (10 M Bytes) fest. Zum Deaktivieren der Komprimierung in der API legen Sie minimumCompressionSize auf Null fest oder entfernen Sie die Eigenschaft. Sie können die Komprimierung für eine API aktivieren oder deaktivieren, indem Sie die API-Gateway-Konsole, die AWS CLI oder die API-Gateway-REST-API verwenden.
Wenn Sie die Komprimierung auf eine Nutzlast jeder beliebigen Größe angewendet werden soll, legen Sie den Wert minimumCompressionSize auf Null fest. Durch die Komprimierung einer kleinen Datengröße kann sich jedoch die endgültige Datengröße erhöhen. Darüber hinaus kann die Komprimierung in API Gateway und die Dekomprimierung im Client die Gesamtlatenzzeit erhöhen und mehr Rechenzeit erfordern. Führen Sie Testläufe für Ihre API aus, um den optimalen Wert zu bestimmen.
Der Client kann eine API-Anfrage mit einer komprimierten Nutzlast und einem geeigneten Content-Encoding-Header für Amazon API Gateway senden, um die Methodenanforderungsnutzlast zu dekomprimieren und geltende Zuweisungsvorlagen anzuwenden, bevor die Anfrage dem Integrationsendpunkt übergeben wird. Nachdem die Komprimierung aktiviert und die API bereitgestellt wurde, kann der Client eine API-Antwort mit einer komprimierten Nutzlast empfangen, wenn ein geeigneter Accept-Encoding-Header in der Methodenanforderung angegeben ist.
Wenn der Integrationsendpunkt nicht komprimierte JSON-Nutzlasten erwartet und zurückgibt, ist jede Zuweisungsvorlage, die für eine nicht komprimierte JSON-Nutzlast konfiguriert ist, für die komprimierte Nutzlast anwendbar. Für eine komprimierte Methodenanforderungsnutzlast dekomprimiert API Gateway die Nutzlast, wendet die Zuweisungsvorlage an und übergibt dem Integrationsendpunkt die zugewiesene Anfrage. Für eine nicht komprimierte Methodenanforderungsnutzlast wendet API Gateway die Zuweisungsvorlage an, komprimiert die zugewiesene Nutzlast und gibt die komprimierte Nutzlast an den Client zurück.
Themen
