Payload-Komprimierung für REST APIs in Gateway API - APIAmazon-Gateway

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Payload-Komprimierung für REST APIs in Gateway API

APIGateway ermöglicht es Ihrem Client, Ihre API mit komprimierten Payloads aufzurufen, indem er eine der unterstützten Inhaltskodierungen verwendet. Standardmäßig unterstützt API Gateway die Dekomprimierung der Payload der Methodenanforderung. Sie müssen Ihre jedoch so konfigurieren, dass API die Komprimierung der Nutzlast der Methodenantwort aktiviert wird.

Um die Komprimierung für eine zu aktivieren API, setzen Sie die minimumCompressionsSizeEigenschaft auf eine nicht negative Ganzzahl zwischen 0 und 10485760 (10 Mio. Byte), wenn Sie die erstellen API oder nachdem Sie die erstellt haben. API Um die Komprimierung für zu deaktivierenAPI, setzen Sie die auf Null oder minimumCompressionSize entfernen Sie sie ganz. Sie können die Komprimierung für eine aktivieren oder deaktivieren, API indem Sie die API Gateway-Konsole AWS CLI, das oder das API Gateway verwenden RESTAPI.

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 können die Komprimierung im API Gateway und die Dekomprimierung im Client die Gesamtlatenz erhöhen und mehr Rechenzeit erfordern. Sie sollten Testfälle anhand Ihres Tests ausführenAPI, um einen optimalen Wert zu ermitteln.

Der Client kann eine API Anfrage mit einer komprimierten Nutzlast und einem entsprechenden Content-Encoding Header einreichen, damit API Gateway die entsprechenden Zuordnungsvorlagen dekomprimieren und anwenden kann, bevor er die Anfrage an den Integrationsendpunkt weiterleitet. Nachdem die Komprimierung aktiviert und API bereitgestellt wurde, kann der Client eine API Antwort mit einer komprimierten Nutzlast erhalten, sofern er in der Methodenanforderung einen entsprechenden Accept-Encoding Header angibt.

Wenn der Integrationsendpunkt unkomprimierte JSON Payloads erwartet und zurückgibt, ist jede Zuordnungsvorlage, die für eine unkomprimierte Payload konfiguriert ist, auf die komprimierte JSON Payload anwendbar. Bei einer komprimierten Nutzlast für Methodenanfragen dekomprimiert API Gateway die Nutzlast, wendet die Zuordnungsvorlage an und leitet die zugeordnete Anforderung an den Integrationsendpunkt weiter. Bei einer unkomprimierten Payload für die Integrationsantwort wendet API Gateway die Zuordnungsvorlage an, komprimiert die zugeordnete Payload und gibt die komprimierte Payload an den Client zurück.