啟用API閘道API內的裝載壓縮 - Amazon API 网关

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

啟用API閘道API內的裝載壓縮

您可以API使用API閘道主控台 AWS CLI、或啟用壓縮 AWS SDK。

對於現有的API,您必須在啟用壓縮API之後部署,變更才會生效。對於新的API,您可以在API安裝完成API後部署。

注意

最高優先順序的內容編碼必須是 Gateway 支援的編碼。API否則系統不會將壓縮功能套用至回應承載。

啟API用使用API閘道主控台的裝載壓縮

下列程序說明如何啟用API.

使用API閘道主控台啟用承載壓縮
  1. 請在 https://console.aws.amazon.com/apigateway 登入API閘道主控台。

  2. 選擇一個現有的API或創建一個新的。

  3. 在主導覽窗格中,選擇 [API設定]。

  4. API詳細資料區段中,選擇編輯

  5. 開啟內容編碼以啟用承載壓縮。針對內文大小下限,輸入代表壓縮大小下限的數字 (位元組)。若要關閉壓縮,請關閉內容編碼選項。

  6. 選擇儲存變更

啟API用使用的裝載壓縮 AWS CLI

若要使用 AWS CLI 建立新的API並啟用壓縮,請依照下列方式呼叫create-rest-api指令:

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

若要使用 AWS CLI 來啟用現有的壓縮API,請依照下列方式呼叫update-rest-api命令:

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

minimumCompressionSize 屬性擁有介於 0 和 10485760 的非負數整數值 (1 千萬個位元組)。它可衡量壓縮閾值。如果承載大小小於這個值,則不會對承載進行壓縮或解壓縮。因此,請將此值設為零以允許任何承載大小使用壓縮功能。

若要使用 AWS CLI 來停用壓縮,請依照下列方式呼叫update-rest-api命令:

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

您也可以將 value 設定為空白字串 "",或在先前的呼叫中徹底省略 value 屬性。

閘道支援的API內容編碼

API網關支持以下內容編碼:

  • deflate

  • gzip

  • identity

API根據 RFC7231 規範,閘道也支援下列Accept-Encoding標頭格式:

  • 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