環境管理とは
すべての API は、テスト、ステージング、本番 の 3 つの環境にグループ化されます。API のテストやデバッグには、テスト環境とステージング環境を使用します。エンドユーザーは本番環境で API を使用します。
API グループの変数パラメーターを追加して、テスト、ステージング、本番環境で使用する API にさまざまな環境ステージを定義できます。環境変数は、各環境でカスタマイズ可能な public 定数です。API の呼び出し時、リクエスト内に環境パラメーターを含めることができます。リクエスト内の環境パラメーターの情報に基づいて、リクエストされた環境が判別されます 。環境変数パラメーターの設定方法
最初に、各環境に変数を作成します。次に、API を定義するときに作成した環境変数を設定します。
環境変数の作成
環境変数を使用してリクエストされた環境を判別するには、テスト、ステージング、本番の各環境ステージに変数を追加する必要があります。
1 つの環境に最大 50 個の環境変数を設定できます。- API Gateway コンソールにログインします。
- [APIグループ] > [環境管理] をクリックします。
- 環境ステージ (本番、ステージング、テスト) を選択し、[変数を追加] をクリックします。環境ステージごとに変数を 1 つずつ追加する必要があります。
変数の名前と値を入力し、[追加] をクリックします。
名前：ユーザー定義の変数名。3 つの環境ステージに対応する変数の名前は同じにしてください。
複数の API がある場合、クエリしやすいように、実際の機能を示す変数名にすることを推奨します。値：変数値。
Function Compute が API Gateway のバックエンドサービスの場合、Function Compute で作成したサービスと関数の名前を変数値として入力します。正しいサービス名と関数名を入力しないと、該当する API を呼び出すことができません。ここでは、例として Function Compute を使用します。関数サービスを使用していて、テスト、ステージング、本番環境でのサービス名が、それぞれ TestServiceD、PreServiceD、ServiceD とします。テスト、ステージング、本番環境の API の変数を定義するとき、変数に “Service” という名前を付け、それぞれのサービス名を値として入力できます。
“Function” という名前の環境ステージ変数の値として関数名を入力し、3 つの環境にそれぞれの変数を設定することもできます。
API 定義での環境変数の設定
API を定義するとき、[リクエストパス]、[入力パラメーター定義]、[API バックエンドサービスの定義] に変数を追加します。
表記方法：#変数名#。例：#Service# や #Function#Function Compute を API Gateway のバックエンドサービスとして設定すると、作成した変数をサービス名や関数名として入力できます。
複数の環境の API の呼び出し
API が公開された後、複数の環境で API を呼び出します。
本番環境の呼び出し
本番環境 API を呼び出すには、環境変数を追加する必要はありません。
ステージング環境の呼び出し
ステージング環境 API を呼び出すには、API の呼び出し時にヘッダーにパラメーター X-Ca-Stage: PRE を追加します。
テスト環境の呼び出し
テスト環境 API を呼び出すには、API の呼び出し時にヘッダーにパラメーター X-Ca-Stage: TEST を追加します。