Amazon API Gateway
開発者ガイド

ドキュメント履歴

次の表に、Amazon API Gateway の前回のリリース以後に行われた、文書の重要な変更を示します。このドキュメントの更新に関する通知については、トップメニューパネルの RSS ボタンを選択して RSS フィードにサブスクライブします。

  • ドキュメントの最終更新日: 2019 年 5 月 3 日

変更 Description 日付

ドキュメントの更新

Amazon API Gateway の開始方法」が修正されました。チュートリアルが「Amazon API Gateway チュートリアル」に移動されました。

May 29, 2019

タグベースのアクセスコントロール

タグベースのアクセスコントロールのサポートを追加しました。詳細については、「タグを IAM ポリシーで使用して API Gateway リソースへのアクセスをコントロールする」を参照してください。

May 23, 2019

ドキュメントの更新

6 つのトピックを書き換えました。「Amazon API Gateway とは?」、「チュートリアル: HTTP プロキシ統合で API をビルドする」、「チュートリアル : 3 つの非プロキシ統合で Calc REST API を作成する」、「API Gateway のマッピングテンプレートとアクセスのログ記録の変数リファレンス」、「API Gateway Lambda オーソライザーの使用」、および「API Gateway REST API リソースの CORS を有効にする」。

April 5, 2019

サーバーレス開発者ポータルの改善

Amazon API Gateway 開発者ポータルで API を発行しやすくするために管理者パネルおよびその他の改善が追加されました。詳細については、「開発者ポータルを使用して API を分類する」を参照してください。

March 28, 2019

AWS Config のサポート

AWS Config のサポートが追加されました。詳細については、「AWS Config による API Gateway API 設定のモニタリング」を参照してください。

March 20, 2019

AWS CloudFormation のサポート

API Gateway V2 API を AWS CloudFormation テンプレートリファレンスに追加しました。詳細については、「Amazon API Gateway V2 リソースタイプのリファレンス」を参照してください。

February 7, 2019

WebSocket API のサポート

WebSocket API のサポートを追加しました。詳細については、「Creating a WebSocket API in Amazon API Gateway」を参照してください。

December 18, 2018

サーバーレス開発者ポータルが AWS Serverless Application Repository 経由で利用可能に​

Amazon API Gateway 開発者ポータルサーバーレスアプリケーションが (GitHub に加えて) AWS Serverless Application Repository から利用できるようになりました。詳細については、「サーバーレス開発者ポータルを使用して、API Gateway API を分類する」を参照してください。

November 16, 2018

AWS WAF のサポート

AWS WAF (ウェブアプリケーションファイアウォール) のサポートを追加しました。詳細については、「AWS WAF を使用した API へのアクセスの制御」を参照してください。

November 5, 2018

サーバーレス開発者ポータル

Amazon API Gateway は、API Gateway API を公開するためにデプロイできるサーバーレスアプリケーションとして、完全にカスタマイズ可能な開発者ポータルを提供します。詳細については、「サーバーレス開発者ポータルを使用して、API Gateway API を分類する」を参照してください。

October 29, 2018

複数値のヘッダーとクエリ文字列パラメータのサポート

Amazon API Gateway は、同じ名前を持つ複数のヘッダーやクエリ文字列パラメータをサポートするようになりました。詳細については、「複数値のヘッダーとクエリ文字列パラメータのサポート」を参照してください。

October 4, 2018

ドキュメントの更新

Amazon API Gateway リソースポリシーが認証ワークフローに影響を与える方法」という新しいトピックを追加しました。

September 27, 2018

OpenAPI のサポート

Amazon API Gateway は OpenAPI 3.0 と OpenAPI (Swagger) 2.0 をサポートするようになりました。

September 27, 2018

AWS X-Ray のアクティブな統合

AWS X-Ray を使用して、API を経由して基盤となるサービスにユーザーリクエストが流れる際に、そのレイテンシーを追跡し、分析できるようになりました。詳細については、「AWS X-Ray を使用した API Gateway API 実行の追跡」を参照してください。

September 6, 2018

キャッシュの改善

API ステージに対してキャッシュを有効にすると、デフォルトでは GET メソッドのみでキャッシュが有効になります。これは、API の安全性を確保するのに役立ちます。オーバーライドするメソッドの設定により、他のメソッドのキャッシュを有効にできます。詳細については、「API キャッシュを有効にして応答性を強化する」を参照してください。

August 20, 2018

サービスの制限の改訂

いくつかの制限が改訂されています。アカウントごとの API の数が増加しました。Create/Import/Deploy API の API レート制限が増加しました。いくつかのレートは 1 分あたりから 1 秒あたりに修正されました。詳細については、「制限」を参照してください。

July 13, 2018

API リクエストとレスポンスパラメータとヘッダーのオーバーライド

レスポンスヘッダーとステータスコードと同様に、リクエストヘッダー、クエリ文字列、およびパスのオーバーライドのサポートが追加されました。詳細については、「マッピングテンプレートを使用して、API のリクエストとレスポンスパラメータとヘッダーをオーバーライドします」を参照してください。

July 12, 2018

使用量プランのメソッドレベルのスロットリング

使用量プラン設定の個々の API メソッドのスロットリング制限と同様に、メソッドあたりのスロットリング制限のデフォルト設定のサポートが追加されました。これらの設定は、ステージ設定で設定できる既存のアカウントレベルのスロットリングとデフォルトのメソッドレベルのスロットリング制限に加えられます。詳細については、「API リクエストを調整してスループットを向上させる」を参照してください。

July 11, 2018

API Gateway 開発者ガイドの更新の通知が RSS を介して利用可能に

HTML 版の API Gateway 開発者ガイド で、このドキュメント履歴ページに説明されている更新の RSS フィードがサポートされるようになりました。RSS フィードには、2018 年 6 月 27 日以降に行われた更新が含まれています。以前に発表された更新は、このページで引き続き利用できます。このフィードにサブスクライブするには、トップメニューパネルの RSS ボタンを使用します。

June 27, 2018

以前の更新

2018 年 6 月 27 日より前の API Gateway 開発者ガイドの各リリースにおける重要な変更点を次の表に示します。

変更 説明 変更日

プライベート API

プライベート API のサポートが追加されました。これは、インターフェイス VPC エンドポイントを介して公開します。プライベート API へのトラフィックは、Amazon のネットワークの外には出ません。パブリックインターネットからは隔離されています。

2018 年 14 月 6 日

アカウント間 Lambda オーソライザーと統合およびアカウント間 Amazon Cognito ユーザープールオーソライザー

Lambda オーソライザー関数または API 統合バックエンドとして、別の AWS アカウントから AWS Lambda 関数を使用します。またはオーソライザーとしての Amazon Cognito ユーザープールを使用します。別のアカウントは、Amazon API Gateway が利用可能な任意のリージョンに設定できます。詳細については、「クロスアカウントの Lambda オーソライザーを設定する」、「チュートリアル: クロスアカウントの Lambda プロキシ統合で API Gateway API をビルドする」、および「API Gateway コンソールを使用して REST API 用のクロスアカウントの Amazon Cognito オーソライザーを設定する」を参照してください。

2018 年 4 月 2 日

API のリソースポリシー

別の API Gateway アカウントのユーザーが、API に安全にアクセスするか、指定された送信元 IP アドレス範囲または CIDR ブロックからのみ API を呼び出すことを許可するには、AWS リソースポリシーを使用します。詳細については、「Amazon API Gateway リソースポリシーを使用して API へのアクセスを制御する」を参照してください。

2018 年 4 月 2 日

API ゲートウェイリソースのタグ付け

API リクエストのコスト配分と API Gateway でのキャッシングのために、API ステージに最大 50 個のタグを付けます。詳細については、「API Gateway で API ステージのタグを設定する」を参照してください。

2017 年 12 月 19 日

ペイロードの圧縮と解凍 サポートされているコンテンツコーディングのいずれかを使用して圧縮ペイロードで API を呼び出すことができます。本文マッピングテンプレートが指定されている場合、圧縮されたペイロードはマッピングの対象となります。詳細については、「API のペイロードの圧縮を有効にする」を参照してください。 2017 年 19 月 12 日
カスタムオーソライザーから発生した API キー カスタムオーソライザーから API Gateway に API キーを返して、キーを必要とする API メソッドの使用量プランを適用します。詳細については、「API キーのソースを選択する」を参照してください。 2017 年 19 月 12 日
OAuth 2 スコープを使用した認証 COGNITO_USER_POOLS オーソライザーで、OAuth 2 スコープを使用してメソッド呼び出しの認証を有効にします。詳細については、「Amazon Cognito ユーザープール をオーソライザーとして使用して REST API へのアクセスを制御する」を参照してください。 2017 年 14 月 12 日
プライベート統合と VPC リンク API Gateway プライベート統合を使用して、クライアントに VpcLink リソースを通じて VPC の外部から Amazon VPC 内の HTTP/HTTPS リソースへのアクセスを提供する API を作成します。詳細については、「チュートリアル: API Gateway プライベート統合で API をビルドする」および「API Gateway のプライベート統合の設定」を参照してください。 2017 年 11 月 30 日
API テストの Canary のデプロイ 既存の API デプロイに Canary リリースを追加して、同じステージで現在のバージョンを維持しながら、新しいバージョンの API をテストします。Canary リリースのステージトラフィックの割合を設定し、個別の CloudWatch Logs ログに記録された Canary 固有の実行とアクセスを有効にすることができます。詳細については、「API Gateway Canary リリースのデプロイをセットアップする」を参照してください。 2017 年 11 月 28 日
アクセスのロギング $context 変数 から派生したデータを使用して、選択した形式でクライアントアクセスを API に記録します。詳細については、「API Gateway CloudWatch の API ログ作成をセットアップする」を参照してください。 2017 年 11 月 21 日
API の Ruby SDK API 用の Ruby SDK を生成し、それを使用して API メソッドを呼び出します。詳細については、「API の Ruby SDK の生成」および「REST API に対して API Gateway で生成された Ruby SDK を使用する」を参照してください。 2017 年 11 月 20 日
リージョン API エンドポイント リージョン API エンドポイントを指定して、非モバイルクライアント用の API を作成します。EC2 インスタンスなどの非モバイルクライアントは、API がデプロイされている同じ AWS リージョンで実行されます。エッジ最適化 API と同様に、リージョン API のカスタムドメイン名を作成できます。詳細については、「API Gateway でリージョン API を設定する」および「API Gateway でリージョン別 API 用のカスタムドメイン名をセットアップする」を参照してください。 2017 年 11 月 2 日
カスタムリクエストオーソライザー カスタムリクエストオーソライザーを使用して、リクエストパラメータにユーザー認証情報を追加して、API メソッド呼び出しを認証します。リクエストパラメータには、ヘッダーやクエリ文字列パラメータだけでなく、ステージ変数やコンテキスト変数が含まれます。詳細については、「API Gateway Lambda オーソライザーの使用」を参照してください。 2017 年 9 月 15 日
ゲートウェイレスポンスのカスタマイズ API リクエストが統合バックエンドに到達しなかった場合に API Gateway で生成されるゲートウェイレスポンスをカスタマイズします。ゲートウェイのメッセージをカスタマイズすることで、API 固有のカスタムエラーメッセージを発信者に提供できます。たとえば、必要な CORS ヘッダーを返したり、ゲートウェイレスポンスデータを外部交換の形式に変換したりできます。詳細については、「エラーレスポンスをカスタマイズするゲートウェイレスポンスをセットアップする」を参照してください。 2017 年 6 月 6 日
Lambda カスタムエラープロパティをメソッドレスポンスのヘッダーにマッピングする integration.response.body パラメータを使用して、Lambda から返される個々のカスタムエラープロパティをメソッドレスポンスのヘッダーパラメータにマッピングします。文字列化されたカスタムエラーオブジェクトは、API Gateway でランタイムに逆シリアル化されます。詳細については、「API Gateway で Lambda のカスタムエラーを処理する」を参照してください。 2017 年 6 月 6 日
スロットリング制限の引き上げ アカウントレベルのリクエストの定常レート制限を 10,000 リクエスト/秒 (rps) に引き上げ、バースト制限を 5,000 同時リクエストに引き上げます。詳細については、「API リクエストを調整してスループットを向上させる」を参照してください。 2017 年 6 月 6 日
メソッドリクエストの検証 API レベルまたはメソッドレベルで基本的なリクエストの検証を設定し、API Gateway が受信リクエストを検証できるようにします。API Gateway は、必須のパラメータが設定されていて空白でないことを確認し、該当するペイロードが設定されたモデルに従っていることを確認します。詳細については、「API Gateway でリクエストの検証を有効化する」を参照してください。 2017 年 4 月 11 日
ACM との統合 API のカスタムドメイン名には ACM 証明書を使用します。AWS Certificate Manager で証明書を作成するか、既存の PEM 形式の証明書を ACM にインポートすることができます。その後、API のカスタムドメイン名を設定するとき、証明書の ARN を参照します。詳細については、「API Gateway で API のカスタムドメイン名を設定する」を参照してください。 2017 年 3 月 9 日
API の Java SDK の生成と呼び出し API Gateway が API の Java SDK を生成できるようにし、SDK を使用して Java クライアントで API を呼び出します。詳細については、「REST API に対して API Gateway で生成された Java SDK を使用する」を参照してください。 2017 年 1 月 13 日
AWS Marketplace との統合 AWS Marketplace を通じて、使用量プランで API を SaaS 製品として販売します。AWS Marketplace を使用して API のリーチを拡大します。顧客への請求は AWS Marketplace が自動的に行います。API Gateway がユーザー認証と使用量計測を処理できるようにします。詳細については、「SaaS としての API の販売」を参照してください。 2016 年 12 月 1 日
API のドキュメントサポートの有効化 API Gateway の DocumentationPart リソースに、API エンティティのドキュメントを追加します。コレクション DocumentationPart インスタンスのスナップショットを API ステージに関連付け、DocumentationVersion を作成します。ドキュメントバージョンを Swagger ファイルなどの外部ファイルにエクスポートすることで、API ドキュメントを発行します。詳細については、「API Gateway での REST API のドキュメント化」を参照してください。 2016 年 12 月 1 日
更新されたカスタムオーソライザー カスタムオーソライザー Lambda 関数が、発信者のプリンシパル ID を返すようになりました。この関数は、context マップと IAM ポリシーのキー/値ペアとして他の情報を返すこともできます。詳細については、「Amazon API Gateway Lambda オーソライザーからの出力」を参照してください。 2016 年 12 月 1 日
バイナリペイロードのサポート API で binaryMediaTypes を設定し、リクエストまたはレスポンスのバイナリペイロードをサポートします。Integration または IntegrationResponsecontentHandling プロパティを設定し、ネイティブバイナリ BLOB、Base64 でエンコードされた文字列、または変更なしのパススルーのどれとしてバイナリペイロードを処理するかを指定します。詳細については、「API Gateway でバイナリペイロードをサポートする」を参照してください。 2016 年 11 月 17 日
API のプロキシリソースを通じた HTTP または Lambda バックエンドとのプロキシ統合の有効化。 {proxy+} の形式の greedy パスパラメータとキャッチオールの ANY メソッドを使用した プロキシリソース の作成。プロキシリソース は、HTTP または Lambda プロキシ統合をそれぞれ使用して、HTTP または Lambda バックエンドと統合されます。詳細については、「プロキシリソースとのプロキシ統合を設定する」を参照してください。 2016 年 9 月 20 日
1 つ以上の使用プランを提供し、顧客への提供商品として、API Gateway で選択した API を拡張します。 承認済みのリクエストレートとクォータで、選択した API クライアントの特定の API ステージへのアクセスを有効にする、API Gateway の使用プランを作成します。詳細については、「API キーを使用する使用量プランの作成と使用」を参照してください。 2016 年 8 月 11 日
Amazon Cognito のユーザープールを使用したメソッドレベルの認証の有効化 Amazon Cognito のユーザープールを作成し、ID プロバイダーとして使用します。ユーザープールに登録されたユーザーにアクセス付与するメソッドレベルの認証としてユーザープールを設定できます。詳細については、「Amazon Cognito ユーザープール をオーソライザーとして使用して REST API へのアクセスを制御する」を参照してください。 2016 年 7 月 28 日
AWS/ApiGateway 名前空間で、Amazon CloudWatch メトリクスおよびディメンションを有効にします。 API Gateway メトリクスは、AWS/ApiGateway の CloudWatch 名前空間で標準化されます。API Gateway コンソールと Amazon CloudWatch コンソールの両方で表示できます。詳細については、「Amazon API Gateway のディメンションおよびメトリクス」を参照してください。 2016 年 7 月 28 日
カスタムドメイン名の証明書の更新を有効にする 証明書の更新により、カスタムドメイン名の証明書の有効期限が切れる場合に、証明書をアップロードして更新することができます。詳細については、「ACM にインポートされた証明書を更新」を参照してください。 2016 年 4 月 27 日
更新された Amazon API Gateway コンソールの変更を文書化します。 更新された API Gateway コンソールを使用して API を設定する方法を説明します。詳細については、「チュートリアル: サンプルをインポートして REST API を作成する」および「チュートリアル: HTTP 非プロキシ統合で API をビルドする」を参照してください。 2016 年 4 月 5 日
API のインポート機能を有効にして、外部の API 定義から新しい API を作成するか、既存の API を有効にします。 API のインポート機能により、新しい API を作成するか、Swagger 2.0 で表された外部の API 定義を API Gateway 拡張機能でアップロードして、既存の API を更新できます。API のインポートの詳細については、「REST API を API Gateway にインポートする」を参照してください。 2016 年 4 月 5 日
$input.body 変数を公開して、raw ペイロードに文字列としてアクセスします。また、$util.parseJson() 関数にアクセスして、マッピングテンプレートで JSON 文字列を JSON オブジェクトに変換します。 $input.body$util.parseJson() の詳細については、「API Gateway マッピングテンプレートとアクセスのログ記録の変数リファレンス」を参照してください。 2016 年 4 月 5 日
メソッドレベルのキャッシュ無効化のクライアントリクエストを有効にして、リクエストのスロットリング管理を向上させます。 API ステージレベルのキャッシュをフラッシュし、個別のキャッシュエントリを無効にします。詳細については、「API Gateway で API ステージキャッシュをフラッシュする」および「API Gateway キャッシュエントリを無効にする」を参照してください。API リクエストのスロットリングを管理するためのコンソールの操作を向上させます。詳細については、「API リクエストを調整してスループットを向上させる」を参照してください。 2016 年 3 月 25 日
カスタム許可を使用した API Gateway API の有効化と呼び出し カスタム許可を実装した AWS Lambda 関数を作成して設定します。この関数は、API Gateway API のクライアントリクエストに許可または拒否のアクセス権限を付与する IAM ポリシードキュメントを返します。詳細については、「API Gateway Lambda オーソライザーの使用」を参照してください。 2016 年 2 月 11 日
Swagger 定義ファイルと拡張機能を使用した API Gateway API のインポートとエクスポート Swagger の指定と API Gateway 拡張機能を使用して、API Gateway API を作成および更新します。API Gateway Importer を使用して Swagger 定義をインポートします。API Gateway コンソールまたは API Gateway Export API を使用して、API Gateway API を Swagger 定義ファイルにエクスポートします。詳細については、「REST API を API Gateway にインポートする」および「REST API をエクスポートする」を参照してください。 2015 年 12 月 18 日
リクエストまたはレスポンス本文または本文の JSON フィールドを、リクエストまたはレスポンスパラメーターにマッピングします。 メソッドリクエストボディまたはその JSON フィールドを統合リクエストのパス、クエリ文字列、またはヘッダーにマッピングします。統合のレスポンス本文またはその JSON フィールドをリクエストレスポンスのヘッダーにマッピングします。詳細については、「Amazon API Gateway API リクエストおよびレスポンスデータマッピングリファレンス」を参照してください。 2015 年 12 月 18 日
Amazon API Gateway でのステージ変数の使用 設定属性を Amazon API Gateway の API のデプロイステージに関連付ける方法について説明します。詳細については、「REST API デプロイのステージ変数を設定する」を参照してください。 2015 年 11 月 5 日
方法: メソッドの CORS を有効にする Amazon API Gateway のメソッド用に CORS (Cross-Origin Resource Sharing) を簡単に有効にできるようになりました。詳細については、「REST API リソースの CORS を有効にする」を参照してください。 2015 年 3 月 11 日
方法: クライアント側 SSL 認証を使用する Amazon API Gateway を使用して、HTTP バックエンドの呼び出しを認証するための SSL 証明書を生成します。詳細については、「バックエンドによる認証のためのクライアント側 SSL 証明書を使用する」を参照してください。 2015 年 9 月 22 日
メソッドのモック統合

API と Amazon API Gateway のモック統合方法について説明を追加しました。この機能により、開発者は最終的な統合バックエンドを事前に用意することなく直接 API Gateway から API 応答を生成できます。

2015 年 9 月 1 日
Amazon Cognito Identity のサポート Amazon API Gateway で $context 変数のスコープが拡大されて、リクエストが Amazon Cognito の認証情報を使用して署名されたときに、Amazon Cognito Identity に関する情報が返されるようになりました。加えて、JavaScript で文字をエスケープして URL と文字列をエンコードするための $util 変数が追加されました。詳細については、「API Gateway マッピングテンプレートとアクセスのログ記録の変数リファレンス」を参照してください。 2015 年 8 月 28 日
Swagger 統合 GitHub の Swagger インポートツールを使用して、Amazon API Gateway に Swagger API の定義をインポートします。「OpenAPI に対する API Gateway 拡張」で、インポートツールを使用した API とメソッドの作成とデプロイについて詳細を追加しました。Swagger インポートツールを使用すると、既存の API を更新できます。 2015 年 7 月 21 日
マッピングテンプレートリファレンス

$input」で、API Gateway マッピングテンプレートとアクセスのログ記録の変数リファレンス パラメータとその機能について説明を追加しました。

2015 年 7 月 18 日
初回一般リリース

これは API Gateway 開発者ガイド の最初の一般リリースです。

2015 年 7 月 9 日

このページの内容: