メニュー
Amazon API Gateway
開発者ガイド

ドキュメント履歴

次の表に、API Gateway 開発者ガイド の前回のリリース以後に行われた、ドキュメントの重要な変更を示します。

  • 文書の最終更新: 2017 年 6 月 6 日

変更 説明 変更日
ゲートウェイレスポンスのカスタマイズ 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 で API の基本的なリクエストの検証を有効にする」を参照してください。 2017 年 4 月 11 日
ACM との統合 API のカスタムドメイン名には ACM 証明書を使用します。AWS Certificate Manager で証明書を作成するか、既存の PEM 形式の証明書を ACM にインポートすることができます。その後、API のカスタムドメイン名を設定するとき、証明書の ARN を参照します。詳細については、「API ホスト名としてのカスタムドメイン名の設定」を参照してください。 2017 年 3 月 9 日
API の Java SDK の生成と呼び出し API Gateway が API の Java SDK を生成できるようにし、SDK を使用して Java クライアントで 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 のドキュメント化」を参照してください。 2016 年 12 月 1 日
更新されたカスタムオーソライザー カスタムオーソライザー Lambda 関数が、発信者のプリンシパル ID を返すようになりました。この関数は、context マップと IAM ポリシーのキー/値ペアとして他の情報を返すこともできます。詳細については、「Amazon API Gateway カスタム認証からの出力」を参照してください。 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 Gateway 使用量プランの使用」を参照してください。 2016 年 8 月 11 日
Amazon Cognito のユーザープールを使用したメソッドレベルの認証の有効化 Amazon Cognito のユーザープールを作成し、ID プロバイダーとして使用します。ユーザープールに登録されたユーザーにアクセス付与するメソッドレベルの認証としてユーザープールを設定できます。 詳細については、「Amazon Cognito ユーザープールを使用」を参照してください。 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 を設定する方法を説明します。詳細については、「例から API Gateway API を作成する」および「HTTP エンドポイントを公開するための API Gateway API を作成する」を参照してください。 2016 年 4 月 5 日
API のインポート機能を有効にして、外部の API 定義から新しい API を作成するか、既存の API を有効にします。 API のインポート機能により、新しい API を作成するか、Swagger 2.0 で表された外部の API 定義を API Gateway 拡張機能でアップロードして、既存の API を更新できます。API のインポートの詳細については、「API をインポートする」を参照してください。 2016 年 4 月 5 日
$input.body 変数を公開して、raw ペイロードに文字列としてアクセスします。また、$util.parseJson() 関数にアクセスして、マッピングテンプレートで JSON 文字列を JSON オブジェクトに変換します。 $input.body$util.parseJson() の詳細については、「マッピングテンプレートの組み込み関数と変数」を参照してください。 2016 年 4 月 5 日
メソッドレベルのキャッシュ無効化のクライアントリクエストを有効にして、リクエストのスロットリング管理を向上させます。 API ステージレベルのキャッシュをフラッシュし、個別のキャッシュエントリを無効にします。詳細については、API Gateway で API ステージキャッシュをフラッシュする および API Gateway キャッシュエントリを無効にする を参照してください。API リクエストのスロットリングを管理するためのコンソールの操作を向上させます。詳細については、「API リクエストを調整してスループットを向上させる」を参照してください。 2016 年 3 月 25 日
カスタム許可を使用した API Gateway API の有効化と呼び出し カスタム許可を実装した AWS Lambda 関数を作成して設定します。この関数は、API Gateway API のクライアントリクエストに許可または拒否のアクセス権限を付与する IAM ポリシードキュメントを返します。詳細については、「カスタム認証の使用」を参照してください。 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 定義ファイルにエクスポートします。詳細については、「API をインポートする」および「API をエクスポートする」を参照してください。 2015 年 12 月 18 日
リクエストまたはレスポンス本文または本文の JSON フィールドを、リクエストまたはレスポンスパラメーターにマッピングします。 メソッドリクエスト本文またはその JSON フィールドを統合リクエストのパス、クエリ文字列、またはヘッダーにマッピングします。統合のレスポンス本文またはその JSON フィールドをリクエストレスポンスのヘッダーにマッピングします。詳細については、「リクエストおよびレスポンスデータのマッピング」を参照してください。 2015 年 12 月 18 日
Amazon API Gateway でのステージ変数の使用 設定属性を Amazon API Gateway の API のデプロイステージに関連付ける方法について説明します。詳細については、「API デプロイメントのステージ変数の設定」を参照してください。 2015 年 11 月 5 日
方法: メソッドの CORS を有効にする Amazon API Gateway のメソッド用に CORS (Cross-Origin Resource Sharing) を簡単に有効にできるようになりました。詳細については、「リソースの 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 変数が追加されました。詳細については、「マッピングテンプレートの組み込み関数と変数」を参照してください。 2015 年 8 月 28 日
Swagger 統合 GitHub の Swagger インポートツールを使用して、Amazon API Gateway に Swagger API の定義をインポートします。「Swagger に対する API Gateway 拡張」で、インポートツールを使用した API とメソッドの作成とデプロイについて詳細を追加しました。Swagger インポートツールを使用すると、既存の API を更新できます。 2015 年 7 月 21 日
マッピングテンプレートリファレンス

マッピングテンプレートの組み込み関数と変数」で、$input パラメータとその機能について説明を追加しました。

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

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

2015 年 7 月 9 日