API gateway では、API を作成する前にグループを作成しなければなりません。1 つのグループに複数の API を含めて、サービスをグループとしてまとめることができます。サービス内のさまざまな機能インターフェイスは、グループ内の API となります。
API を公開、API を API Gateway に接続する方法がしっかり理解できるよう、次の API 設定手順で例示します。
- サービス名: 公開されている API のサービス情報を照会する
- サービス詳細:API を呼び出し、公開されている API とその詳細の一覧を照会できます。
例 1:Path に動的パラメーターを含まない
例 2:Pathに動的パラメーターを含む
柔軟なフロントエンドおよびバックエンドのマッピング:
フロントエンド: API を呼び出したときに API リクエストがクライアントから API Gateway を経由する部分を指します。
バックエンド:API Gateway に到達した API リクエストが、API Gateway を経由して実際のバックエンド サービスに到達する部分を指します。
- バックエンド ホストは、フロントエンド ドメイン名とは異なります。
- バックエンド path は、フロントエンド path とは異なります。
- ユーザーの入力するパラメーターの位置と名前は実際のバックエンド サービスが受け取るパラメーターの位置と名前とは異なります(フロントエンドおよびバックエンドでは、リクエストの body は、バイナリ形式または form でなければならないことにご注意ください)。
API gateway は、包括的にフロントエンドおよびバックエンドをマッピングできます。
前述の例のパラメーター設定の基本的な手順は次のとおりです(例として例 2 を使用)。