API閘道RESTAPIs中的裝載壓縮 - Amazon API 网关

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

API閘道RESTAPIs中的裝載壓縮

APIGateway 允許您的用戶端使API用其中一種支援的內容編碼來呼叫您的壓縮裝載。默認情況下,APIGateway 支持方法請求有效負載的解壓縮。但是,您必須API將您的配置為啟用方法響應有效負載的壓縮。

若要啟用壓縮 API,請在建立API或建立之後,將內minimumCompressionsSize容設定為介於 0 到 10485760 (10M 位元組) 之間的非負整數。API若要停用上的壓縮API,請將設定minimumCompressionSize為 null 或將其完全移除。您可以使用API閘道主控台、或閘道API來啟用或停用的API壓縮RESTAPI。 AWS CLI

如果您想要對任何大小的承載套用壓縮功能,請將 minimumCompressionSize 值設定為零。不過,壓縮大小很小的資料實際上可能會增加最終資料大小。此外,APIGateway 中的壓縮和用戶端中的解壓縮可能會增加整體延遲,並且需要更多的運算時間。您應該針對您運行測試用例API以確定最佳值。

用戶端可以在將API要求傳送至整合端點之前,提交包含壓縮承載和適當Content-Encoding標頭的要求,讓 API Gateway 解壓縮並套用適用的對應範本。啟用壓縮並部署之後,如果API用戶端在方法要求中指定了適當的Accept-Encoding標頭,則用戶端可以接收含有壓縮裝載的API回應。

當整合端點預期並傳回未壓縮JSON承載時,針對未壓縮承載設定的任何對應範本都適用於壓縮的JSON承載。針對壓縮方法要求承載,APIGateway 會將承載解壓縮、套用對應範本,並將對應的要求傳送至整合端點。對於未壓縮的整合回應承載,APIGateway 會套用對應範本、壓縮對應的承載,然後將壓縮的承載傳回給用戶端。