API Gateway:環境の管理

環境管理とは何ですか?

環境管理とは、ソフトウェアの開発、テスト、デプロイなど、さまざまな段階でさまざまな目的のために作成および維持される環境の管理を指します。 通常、環境は、テスト、ステージング、および生産の3つのカテゴリに分類されます。 環境を適切に管理することで、ソフトウェアの品質、安定性、セキュリティを確保し、チームワークを促進します。

API Gatewayは、TEST、PRE、RELEASEの3つの組み込み環境を提供します。 それとは別に、API Gatewayを使用すると、ビジネス要件に基づいてカスタム環境を作成して使用できます。 同じAPI設定セットに基づいて、環境ごとに異なるR&Dステージのバックエンドサービスを分離できます。 これにより、R&Dの効率とAPIの管理性が向上します。

API環境の適切な使用には、通常3つのステップが含まれます。

• (オプション) カスタム環境の作成と維持: API Gatewayコンソールを使用して、独自の環境を作成および維持できます。

• バックエンドサービスの設定: テスト、ステージング、運用環境など、さまざまな環境でバックエンドサービスのさまざまな設定を設定できます。 これにより、APIリクエストを異なるバックエンドURLにルーティングできます。

• クライアントの設定: ユーザーはクライアントでリクエストを送信するためにURLを明示的に指定する必要があります。 異なるドメイン名を異なるAPIグループにバインドするか、APIリクエストにX-Ca-Stageヘッダーを追加するようにユーザーに要求することができます。

1. 環境を作成するCreate an environment

API Gatewayには、TEST、PRE、RELEASEの3つの組み込み環境があります。 これらの環境がビジネス要件を満たしていない場合は、独自の環境を作成できます。

1. API Gatewayコンソールにログインして、利用可能な環境を表示します。

2. 環境を作成する場合は、[環境の作成] をクリックします。 [環境の作成] ダイアログボックスで、環境名、エイリアス、および説明を入力します。 環境名とエイリアスはグローバルに一意である必要があります。

   • 環境名: 名前は2 ~ 10文字で、大文字と数字を使用できます。 名前は大文字で始める必要があります。

   • Alias: 環境の表示名。 エイリアスの長さは2 ~ 50文字で、英数字、アンダースコア (_) を使用できます。

   • Description: 環境の説明。

3. [確認] をクリックして環境の作成を完了します。

2. 環境を使用するUse the environment

2.1 バックエンドサービスを作成し、環境URLを設定します

バックエンドサービスを使用してAPIのバックエンドアプリケーションを管理することを推奨します。 バックエンドサービスに異なる環境URLを設定して、異なる環境のアプリケーションを区別できます。 詳細については、「バックエンドサービスを使用してAPIを作成および管理する」の手順1および2をご参照ください。

2.2 APIを環境に公開する

バックエンドサービスを作成して設定したら、ユーザーが呼び出すバックエンドサービス用のAPIを作成する必要があります。 APIを作成およびデバッグする方法の詳細については、「バックエンドサービスを使用してAPIを作成および管理する」の手順3、4、および5をご参照ください。 システムが提供するTEST、PRE、RELEASE環境、カスタム環境など、利用可能なすべての環境にAPIを公開できます。

2.3 X-Ca-Stageヘッダーを使用して、指定された環境でAPIを呼び出す

APIをデバッグするときは、システムが提供する第2レベルのドメイン名またはX-Ca-Stageリクエストヘッダーを使用して、APIをトライアルコールできます。 APIが属するAPIグループに独立したドメイン名をバインドしていて、バインドの実行時にEnvironmentパラメーターがDefault (X-Ca-Stage) に設定されている場合、ユーザーはX-Ca-Stageヘッダーを使用してAPIリクエストの送信先の環境を指定できます。

• RELEASE環境でAPIを呼び出す場合、ユーザーはAPIリクエストでX-Ca-Stageパラメーターを指定する必要はありません。

• PRE環境でAPIを呼び出すには、各APIリクエストにX-Ca-Stage: PREヘッダーを追加する必要があります。

• TEST環境でAPIを呼び出すには、各APIリクエストにX-Ca-Stage: TESTヘッダーを追加する必要があります。

• カスタム環境でAPIを呼び出すには、各APIリクエストにX-Ca-Stage: environment nameヘッダーを追加する必要があります。 環境を実際の環境名に置き換える必要があります。

2.4 独立したドメイン名を特定の環境にバインドする

環境ごとに個別のドメイン名をバインドできます。 これにより、ユーザーはAPIを呼び出す環境を指定するためにX-Ca-Stageヘッダーを使用する必要がなくなります。 独立したドメイン名をAPIグループにバインドするときに、目的の環境を選択できます。 独立したドメイン名をバインドする方法の詳細については、「カスタムドメイン名をバインドしてAPI呼び出しを許可する」をご参照ください。

3. 環境の削除

1. API Gatewayコンソールにログインして、利用可能な環境を表示します。

2. 削除する環境を見つけて、[操作] 列の [削除] をクリックします。