Endpoint Types¶
An Endpoint is a specific destination for a message such as an address, WSDL, a failover group, a load-balance group etc. WSO2 API Manager supports a range of different endpoint types, allowing the API Gateway to connect with advanced types of backends.
Type | Description |
---|---|
HTTP/ REST Endpoint | A REST service endpoint based on a URI template. |
HTTP/ SOAP Endpoint | The direct URL of the SOAP web service. |
Service Endpoint | A REST service endpoint of a service entry which is available in the service catalog. |
Failover Group Endpoint | The endpoints that the service tries to connect to in case of a failure. Selecting the endpoint when the primary endpoint fails, happens in a round-robin manner. Failover Group is a group of leaf endpoints (i.e., address endpoint, HTTP endpoint, and WSDL endpoint). When a failure occurs in the current endpoint (while sending a message), the failover group endpoint will try to send the message to another endpoint. The failover group ensures that the message is delivered as long as there is at least one active endpoint among the listed endpoints. |
Load Balance Endpoint | The endpoints where the incoming requests are directed to in a round-robin manner. They automatically handle fail-over as well. |
Dynamic Endpoint | Using a dynamic endpoint, the requests can be dynamically routed to an address based on a specific condition (e.g., request parameters, payload etc.). When using this endpoint type, a mediation sequence should be applied to the message IN Flow of the API. For more information, see Adding Dynamic Endpoints. |
Mock Implementation |
|
AWS Lambda | An AWS Lambda endpoint can be used to invoke AWS Lambda functions through WSO2 API Gateway. For more information on creating APIs with AWS Lambda endpoint, see Create and Publish an AWS Lambda API. |
Note the following:
- You can expose both REST and SOAP services to consumers through APIs.
- You can call backend services secured with OAuth 2.0, username/password (Basic Auth or Digest Auth) through APIs created in the API Publisher.
- The system reads Gateway endpoints from the
<API-M_HOME>/repository/conf/deployment.toml
file. When there are multiple gateway environments defined, it picks the Gateway endpoint of the production environment. You can define both HTTP and HTTPS gateway endpoints as follows:
[[apim.gateway.environment]]
name = "Production Environment"
type = "production"
...
http_endpoint = "http://localhost:${http.nio.port}"
https_endpoint = "https://localhost:${https.nio.port}"
If both types of endpoints are defined, the HTTPS endpoint will be picked as the server endpoint.
Tip
When you define secured (HTTPS) endpoints, set the HostnameVerifier
parameter to AllowAll
in the <API-M_HOME>/repository/conf/deployment.toml
file's HTTPS transport sender configuration.