Amazon API Gateway
開発者ガイド

API Gateway コンソールから REST API をデプロイする

REST API は、初めてデプロイする前に作成済みであることが必要です。詳細については、「Amazon API Gateway で REST API を作成する」を参照してください。

REST API をステージにデプロイする

API Gateway コンソールでは、デプロイを作成して新規または既存のステージに関連付けることで API をデプロイできます。

注記

API Gateway のステージに別のデプロイを関連付けるには、代わりに「ステージを別の REST API デプロイと関連付ける」を参照してください。

  1. https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。

  2. [API] ナビゲーションペインで、デプロイする API を選択します。

  3. [リソース] ナビゲーションペインで、[アクション] を選択します。

  4. [アクション] ドロップダウンメニューから [API のデプロイ] を選択します。

  5. [API のデプロイ] ダイアログで、[デプロイされるステージ] ドロップダウンリストからエントリを選択します。

  6. [新しいステージ] を選択し、[ステージ名] に名前を入力します。必要に応じて、[ステージの説明] と [デプロイメントの説明] にステージとデプロイの説明を入力します。既存のステージを選択した場合は、[デプロイメントの説明] に新しいデプロイの説明を入力できます。

  7. [デプロイ] を選択して、デフォルトのステージ設定で指定のステージに API をデプロイします。

REST API デプロイのステージ設定を更新する

API のデプロイ後に、ステージ設定を変更して API キャッシュ、ログ記録、またはリクエストのスロットリングを有効または無効にすることができます。また、バックエンドで API Gateway を検証するためのクライアント証明書を選択したり、実行時に API 統合にデプロイコンテキストを渡すようにステージ変数を設定したりすることもできます。詳細については、「ステージ設定の更新」を参照してください。

重要

ステージ設定を変更したら、変更を有効にするために API を再デプロイする必要があります。

注記

ログ作成の有効化など、更新した設定が新しい IAM ロールを必要とする場合、API を再デプロイせずに必要な IAM ロールを追加できます。ただし新しい IAM ロールが有効になるまでには、数分かかる場合があります。有効になるまでは、ログ作成オプションを有効にしていたとしても、API 呼び出しのトレースは記録されません。

REST API デプロイのステージ変数を設定する

デプロイで、ランタイムに API 統合に対してデプロイ固有のデータを渡すようにステージ変数を設定または変更できます。この操作は、[ステージエディター] の [ステージ変数] タブで行うことができます。詳細については、「REST API デプロイのステージ変数を設定する」の手順を参照してください。

ステージを別の REST API デプロイと関連付ける

デプロイは API スナップショットを表し、ステージはスナップショットへのパスを定義するため、別のデプロイとステージの組み合わせを選択して、ユーザーが API の異なるバージョンを呼び出す方法を制御できます。これは、API のステージを前のデプロイにロールバックしたり、API の「プライベートブランチ」をパブリックブランチにマージしたりする場合に役立ちます。

次の手順では、この操作を API Gateway コンソールの [ステージエディター] を使用して行う方法について説明します。以下では、API を複数回デプロイした経験があることを前提としています。

  1. [ステージエディター] をまだ開いていない場合は、[API] メインナビゲーションペインで API の [ステージ] オプションからデプロイを更新するステージを選択します。

  2. [デプロイ履歴] タブで、ステージに使用するデプロイの横にあるオプションボタンを選択します。

  3. [デプロイの変更] を選択します。