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

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

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

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

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

注記

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

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

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

  3. [Resources] ナビゲーションペインで、[Actions] を選択します。

  4. [Actions] ドロップダウンメニューから [Deploy API] を選択します。

  5. [Deploy API] ダイアログで、[Deployment stage] ドロップダウンリストからエントリを選択します。

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

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

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

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

注記

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

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

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

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

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

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

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

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

  3. [Change Deployment] を選択します。