Amazon API Gateway
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

为 API 启用负载压缩

您可以使用 API Gateway 控制台、AWS CLI 或 AWS 开发工具包实现 API 的压缩。

对于现有 API,您必须在启用压缩后部署 API,这样更改才能生效。对于新 API,您可以在 API 设置完成后部署该 API。

注意

最高优先级内容编码必须是 API Gateway 支持的编码。如果不是,将不对响应负载应用压缩。

使用 API Gateway 控制台为 API 启用负载压缩

以下过程介绍如何为 API 启用负载压缩。

使用 API Gateway 控制台启用负载压缩

  1. 登录到 API Gateway 控制台。

  2. 选择现有 API 或者创建新 API。

  3. 在主导航窗格中您选定的或创建的 API 下,选择设置

  4. 设置窗格的 Content Encoding (内容编码) 部分下,选择 Content Encoding enabled (启用内容编码) 选项以启用负载压缩。在 Minimum body size required for compression (压缩要求的最小正文大小) 旁,为最小压缩大小键入数字(字节)。要禁用压缩,请清除 Content Encoding enabled (启用内容编码) 选项。

  5. 选择 Save Changes (保存更改)

使用 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(10M 字节)之间的非负整数值。它可测量压缩阈值。如果负载大小小于该值,则不会对负载应用压缩或解压缩。将它设置为零允许对任何负载大小进行压缩。

要使用 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=1.0

  • Accept-Encoding:gzip;q=1.0,identity;q=0.5,*;q=0