This documentation is for WSO2 Enterprise Service Bus version 4.9.0 . View documentation for the latest release.
||
Skip to end of metadata
Go to start of metadata

The HTTP endpoint allows you to define REST endpoints using URI templates similar to the REST API. The URI templates allow a RESTful URI to contain variables that can be populated during mediation runtime using property values whose names have the "uri.var." prefix. An HTTP endpoint can also define the particular HTTP method to use in the RESTful invocation.



XML Configuration

Note

You can configure the HTTP endpoint using XML. Click on Switch to source view link in the HTTP Endpoint page.

The syntax is as follows.

<http uri-template="URI Template" method="GET|POST|PATCH|PUT|DELETE|OPTIONS|HEAD" />

HTTP Endpoint Attributes

Attribute

Description

uri-template

The URI template that constructs the RESTful endpoint URL at runtime.

method

The HTTP method to use during the invocation.


UI Configuration

The following page is opened by clicking HTTP Endpoint in the Add Endpoint tab of the Manage Endpoints page.

The parameters available to configure an HTTP endpoint are as follows.

Parameter NameDescription
NameThis parameter is used to enter a unique name for the endpoint.
URI Template

The URI template of the endpoint. Insert uri.var. before each variable. Click Test to test the URI.

If the endpoint URL is an encoded URL, then you need to add legacy-encoding: when defining the uri-template.

e.g., uri-template="legacy-encoding:{uri.var.APIurl}"

HTTP Method

The HTTP method to use during the invocation of the endpoint. Supported methods are as follows.

  • Get
  • Post
  • Patch
  • Put
  • Delete
  • Options
  • Head
  • Leave-as-is
Show Advanced OptionsClick this link if you want to add advanced options to the endpoint. See Advanced Options for details of common advanced options you can add.

You can create HTTP endpoints by specifying values for the parameters given above.

Alternatively, you can specify one parameter as the HTTP endpoint by using multiple other parameters, and then pass that to define the HTTP endpoint as follows:

<property name="uri.var.httpendpointurl" expression="fn:concat($ctx:prefixuri, $ctx:host, $ctx:port, $ctx:urlparam1, $ctx:urlparam2)" />
<send>
<endpoint>
<http uri-template="
{uri.var.httpendpointurl}
"/>
</endpoint>
</send>

Example

<endpoint xmlns="http://ws.apache.org/ns/synapse" name="HTTPEndpoint">
    <http uri-template="http://localhost:8080/{uri.var.servicepath}/restapi/{uri.var.servicename}/menu?category={uri.var.category}&amp;type={uri.var.pizzaType}" method="GET">
</http>
</endpoint>

When entering the endpoint URL in the ESB management console, ensure you replace '&' character in the endpoint URL with '&amp;'

The URI template variables in this example HTTP endpoint can be populated during mediation as follows:

<inSequence>           
            <property name="uri.var.servicepath" value="PizzaShopServlet"/>
            <property name="uri.var.servicename" value="PizzaWS"/>
            <property name="uri.var.category" value="pizza"/>
            <property name="uri.var.pizzaType" value="pan"/>
            <send>
                <endpoint key="HTTPEndpoint"/>
            </send>
</inSequence>

This configuration will cause the RESTful URL to evaluate to:

http://localhost:8080/PizzaShopServlet/restapi/PizzaWS/menu?category=pizza&type=pan


  • No labels