1.3.3. プロダクトへのバックエンドの追加
本セクションでは、プロダクトへのバックエンドの追加について説明します。プロダクトに追加する各バックエンドについて、この手順を繰り返すことができます。
前提条件
- プロダクト。プロダクトの作成については、API コールをテストするための新規プロダクトの作成 を参照してください。
- 1 つまたは複数のバックエンド。バックエンドの作成については、新規バックエンドの作成 を参照してください。
手順
- Dashboard の [Your_product_name] から、Integration > Backends の順に移動します。
- Add Backend をクリックします。
- ドロップダウンリストから既存のバックエンドを選択します。
- Path テキストボックスでルーティングパスを指定します。詳細については、バックエンドパス を参照してください。
- Add to Product をクリックします。
これらの手順を完了すると、プロダクトにバックエンドが追加されます。プロダクトにバックエンドをさらに追加する、あるいは別のプロダクトにバックエンドを追加する場合には、再度この手順を実施することができます。
バックエンドパス
バックエンドをプロダクトに追加する場合、その特定のプロダクトに関してバックエンドが使用するパスを定義します。このパスは、バックエンドの一部ではありません。
プロダクトへのバックエンドの追加 に記載の手順から、APIcast はステップ 4 で指定したバックエンドのパスを使用します。APIcast はリクエストされたエンドポイントパスを前方一致で照合し、指定したパスを使用してトラフィックをバックエンドにリダイレクトします。
バックエンドのパスを定義する際の留意事項は以下のとおりです。
-
バックエンドの 1 つのパスとして、
/
を指定することができます。 - 1 つのプロダクト内では、パスは一意でなければなりません。つまり、1 つのプロダクト内では、同じパスを使用して 2 つのバックエンドを追加することはできません。また、1 つのプロダクトに、同じバックエンドを 2 回追加することもできません。
- プロダクトが異なっていれば、1 つのバックエンドに同じパスを指定することができます。
バックエンドパスが機能する仕組みを以下に示します。
- プロダクトに追加されたそれぞれのバックエンドは、指定したパスにマウントされます。
- トラフィックをリダイレクトする前に、プロダクトに対するリクエストの公開 URL からパスが削除されます。
例
プロダクトにバックエンドを追加する以下の設定について考えます。
- バックエンド: Inventory
-
リソースパス:
/list
- プロダクト: Petstore
-
バックエンドパス:
/supplies
この設定で使用される URL は以下のとおりです。
-
公開 URL:
<public-api-domain>/supplies/list
-
プライベート URL:
<private-api-domain>/list
リクエストが送信された際のアクションのフローを以下に示します。
- アプリケーションがリクエストを送信する。
-
リクエストが公開 URL
<public-api-domain>/supplies/list
に送信される。 -
プライベート URL
<private-api-domain>/list
にリダイレクトする前に、バックエンドパスが削除される。 - リクエストが Inventory バックエンドにリダイレクトされる。