在 API Gateway 中啟用 API 的承載壓縮功能 - Amazon API Gateway
使用 API Gateway 主控台啟用 API 的承載壓縮功能使用 AWS CLI 啟用 API 的承載壓縮功能API Gateway 支援的內容編碼

在 API Gateway 中啟用 API 的承載壓縮功能

您可以使用 API Gateway 主控台、AWS CLI 或 AWS 軟體開發套件來啟用 API 的壓縮功能。

針對現有的 API，您必須在啟用壓縮後部署 API，以使變更生效。針對新的 API，您可以在 API 設定完成後部署 API。

注意

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

使用 API Gateway 主控台啟用 API 的承載壓縮功能

下列程序說明如何啟用 API 的承載壓縮功能。

使用 API Gateway 主控台來啟用承載壓縮功能

  1. 在以下網址登入 API Gateway 主控台：https://console.aws.amazon.com/apigateway。

  2. 選擇現有的 API 或建立新的 API。

  3. 在主導覽窗格中，選擇 API 設定。

  4. 在 API 詳細資訊區段中，選擇編輯。

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

  6. 選擇儲存變更。

使用 AWS CLI 啟用 API 的承載壓縮功能

若要使用 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 Gateway 支援的內容編碼

API Gateway 支援下列內容編碼：

  • deflate

  • gzip

  • identity

根據 RFC 7231 規格，API Gateway 也支援下列 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