Serverless APIのレスポンス圧縮設定を確認

レスポンスの特性に合う圧縮しきい値を選んでください。

説明

API Gateway REST APIのminimumCompressionSizeは、圧縮する本文の最小サイズをバイト単位で指定します。圧縮は転送効率のための機能であり、暗号化の代わりにはなりません。

想定される影響

大きなレスポンスを圧縮しないと、転送量や遅延が増える場合があります。小さなレスポンスでは、圧縮の負荷が効果を上回ることもあります。

対処方法

必要に応じてprovider.apiGateway.minimumCompressionSizeに0から10485760までの値を指定してください。実際のレスポンスとクライアントの圧縮対応を確認して調整してください。

例

Serverless Framework 4でしきい値を1024バイトにする抜粋です。REST APIの関数とイベントの定義は省略しています。

変更前

yaml
service: my-service
frameworkVersion: '4'
provider:
  name: aws
  apiGateway: {}

変更後

yaml
service: my-service
frameworkVersion: '4'
provider:
  name: aws
  apiGateway:
    minimumCompressionSize: 1024

参考資料