viewing Apigee X documentation.
View Apigee Edge documentation.
Apigee lets you invoke one API proxy from another API proxy. This feature is useful especially if you have an API proxy that contains reusable code that can be used by other API proxies.
Invoking one API proxy from another either using
HTTPTargetConnection in the target endpoint or
Invoke proxy 2 from proxy 1 using
The following code sample invokes proxy 2 from proxy 1 using
<!-- /antipatterns/examples/2-1.xml --> <HTTPTargetConnection> <URL>https://api-test.example.com/proxy2</URL> </HTTPTargetConnection>
<!-- /antipatterns/examples/2-2.xml --> var response = httpClient.send('https://api-test.example.com/proxy2); response.waitForComplete();
To understand why this has an inherent disadvantage, we need to understand the route a request takes as illustrated by the diagram below:
As depicted in the diagram, a request traverses multiple distributed components, including the Router and the Message Processor.
In the code samples above, invoking proxy 2 from proxy 1 means that the request has to be routed through the traditional route (Router > MP) at runtime. This would be akin to invoking an API from a client thereby making multiple network hops that add to the latency. These hops are unnecessary considering that proxy 1 request has already reached the MP.
Invoking one API proxy from another API proxy incurs unnecessary network hops, that is the request has to be passed on from one Message Processor to another Message Processor.
- Use the proxy chaining
feature for invoking one API Proxy from another. Proxy chaining is more
efficient as it uses local connection to reference the target endpoint (another API Proxy).
The code sample shows proxy chaining using
LocalTargetConnectionin your endpoint definition:
<!-- /antipatterns/examples/2-3.xml --> <LocalTargetConnection> <APIProxy>proxy2</APIProxy> <ProxyEndpoint>default</ProxyEndpoint> </LocalTargetConnection>
The invoked API Proxy gets executed within the same Message Processor; as a result, it avoids the network hop as shown in the following figure: