Message Flow in the API Manager Gateway
The Gateway of an API Manager deployment is responsible for the main business funtionality of serving API traffic. The following diagram illustrates the message flow in the Gateway at a very high level.
The Handlers
The handlers are request and response interceptors. The list of API handlers in APIM 2.1.0 are as follows:
APIMgtLatencyStatsHandler
CORSRequestHandler
APIAuthenticationHandler
ThrottleHandler
APIMgtUsageHandler
APIMgtGoogleAnalyticsTrackingHandler
APIManagerExtensionHandler
Each Handler performs a specific task which is mentioned in the table below. Note that some handlers are functional both at the inflow and outflow of messages.
Handler | Inflow | Outflow |
|---|---|---|
APIMgtLatencyStatsHandler | Publish request and response latencies, if analytics is enabled | Publish request and response latencies, if analytics is enabled |
CORSRequestHandler | Set CORS Headers | Set CORS Headers |
APIAuthenticationHandler | request authentication | N/A |
ThrottleHandler | request throttling | N/A |
APIMgtUsageHandler | publish request data, if analytics is enabled | N/A |
APIMgtGoogleAnalyticsTrackingHandler | publish data to Google Analytics, if Google Analytics is configured | N/A |
APIManagerExtensionHandler | execute custom mediation sequences at inflow | execute custom mediation sequences at outflow |
Mediation Extensions
Mediation extensions are the custom mediation logic that can be executed in either inflow or the outflow. For more details on how to configure mediation extensions, see Adding Mediation Extensions.
In Sequence and Out Sequence
In sequence and the out sequence carry the mail business logic of the request flow. In sequence handles sending the request from the client to the backend, and the out sequence routes the response sent from the backed to the client.