Apigee では、ある API プロキシから別の API プロキシを呼び出せます。この機能は、API プロキシに、他の API プロキシで使用できる再利用可能なコードが含まれている場合に利用できます。
アンチパターン
ターゲット エンドポイントで HTTPTargetConnection
を使用するか、カスタム JavaScript コードを使用して、ある API プロキシから別の API プロキシを呼び出すと、追加的なネットワーク ホップが生じます。
HTTPTargetConnection
を使用してプロキシ 1 からプロキシ 2 を呼び出す
次のコードサンプルは、HTTPTargetConnection
を使用してプロキシ 1 からプロキシ 2 を呼び出します。
<!-- /antipatterns/examples/2-1.xml --> <HTTPTargetConnection> <URL>https://api-test.example.com/proxy2</URL> </HTTPTargetConnection>
JavaScript コードを使用してプロキシ 1 からプロキシ 2 を呼び出す
次のコードサンプルは、JavaScript を使用してプロキシ 1 からプロキシ 2 を呼び出します。
<!-- /antipatterns/examples/2-2.xml --> var response = httpClient.send('https://api-test.example.com/proxy2); response.waitForComplete();
コードのフロー
この方法に本質的なデメリットがある理由を理解するには、次の図に示すように、リクエストが送信されるルートを理解する必要があります。

図に示すように、リクエストは Router と Message Processor を含む複数の分散コンポーネントを経由します。
上記のコードサンプルでは、プロキシ 1 からプロキシ 2 を呼び出す場合、実行時にリクエストは従来のルート(Router から MP へ)を経由することになります。これにより、クライアントから API を呼び出す場合と同様、複数のネットワーク ホップが生じてレイテンシの増大につながります。プロキシ 1 のリクエストが MP にすでに到達したことを考慮すると、このホップは不要です。
効果
ある API プロキシから別の API プロキシを呼び出すと、不要なネットワーク ホップが生じ、リクエストが 1 つの Message Processor から別の Message Processor に渡されることになります。
ベスト プラクティス
- ある API プロキシから別の API プロキシを呼び出す場合に、プロキシ チェーン機能を使用します。プロキシ チェーンはローカル接続を使用してターゲット エンドポイント(別の API プロキシ)を参照するため、より効率的です。
コードサンプルは、エンドポイント定義で
LocalTargetConnection
を使用したプロキシ チェーンを示しています。<!-- /antipatterns/examples/2-3.xml --> <LocalTargetConnection> <APIProxy>proxy2</APIProxy> <ProxyEndpoint>default</ProxyEndpoint> </LocalTargetConnection>
呼び出された API プロキシは、同じ Message Processor で実行されます。その結果、次の図に示すようにネットワーク ホップの発生が回避されます。
図 2: プロキシ チェーンのコードフロー