Amazon API Gateway
開発者ガイド

API のペイロードの圧縮を有効にする

API Gateway コンソール、AWS CLI、または AWS SDK を使用して API の圧縮を有効にできます。

既存の API では、圧縮を有効にした後、API をデプロイして変更を有効にする必要があります。新しい API の場合、API のセットアップ完了後に API をデプロイします。

API Gateway コンソールを使用して API のペイロード圧縮を有効にする

次の手順では、API のペイロードの圧縮を有効にする方法について説明します。

API Gateway コンソールを使用してペイロードの圧縮を有効にするには

  1. API Gateway コンソールにサインインします。

  2. 既存の API を選択するか、新しい API を作成します。

  3. プライマリナビゲーションペインで、選択した、または作成した API の下で [設定] を選択します。

  4. [設定] ペインの [コンテンツのエンコード] セクションで、[コンテンツのエンコードが有効] オプションを選択してペイロードの圧縮を有効にします。圧縮に必要な本文の最小サイズの横にある最小圧縮サイズ (バイト単位) の数を入力します。圧縮を無効にするには、[コンテンツのエンコードが有効] オプションをオフにします。

  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

API Gateway は RFC 7231 仕様に従って、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