This documentation is for WSO2 API Manager 1.10.0 View documentation for the latest release.
Page Comparison - Map the Parameters of your Backend URLs with the API Publisher URLs (v.1 vs v.2) - API Manager 1.10.0 - WSO2 Documentation

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

Include PageAPIMShared:Map the Parameters of your Backend URLs with the API Publisher URLs V2APIMShared:Map the Parameters of your Backend URLs with the API Publisher URLs V2This tutorial explains how to map your backend URLs to the pattern that you want in the API Publisher. Note the following:

  1. The URL pattern of the APIs in the Publisher is http://<hostname>:8280/<context>/<version>/<API resource>.
  2. You can define variables as part of the URI template of your API's resources. For example, in the URI template /business/{businessId}/address/, businessId is a variable.
  3. The variables in the resources are read during mediation runtime using property values with the "uri.var." prefix. For example, this HTTP endpoint gets the businessId that you specify in the resource http://localhost:8280/businesses/{uri.var.businessId}/details.
  4. The URI template of the API's resource is automatically appended to the end of the HTTP endpoint at runtime. You can use the following mediator setting to remove the URL postfix from the backend endpoint: <property name="REST_URL_POSTFIX" scope="axis2" action="remove"/>

We do the following mapping in this tutorial:

Image Added

Before you begin, note that a mock backend implementation is set up in this tutorial for the purpose of demonstrating the API invocation. If you have a local API Manager setup, save this file in the <APIM_HOME>/repository/deployment/server/synapse-configs/default/api folder to set up the mock backend. 

  1. Log in to the API Publisher, design a new API with the following information and then click Implement.

    Field Sample value
    Name TestAPI
    Context /test
    Version 1.0.0
    Visibility Public
    ResourcesURL pattern/business/{businessId}/address/
     Request types


    Image Added

  2. The Implement tab opens. Give the information in the table below. 

    FieldSample value
    Endpoint typeHTTP endpoint
    Production endpoint


    Image Added

  3. Click Manage to go to the Manage tab, select the Gold tier and publish the API.
    Image Added
    As the API's resource is appended to its endpoint by Synapse at runtime, let's write a custom sequence to remove this appended resource.

  4. Copy the the following to a text editor and save the file in XML format (e.g., TestSequence.xml).

    Code Block
    <sequence xmlns="" name="TestSequence">
        <property name="REST_URL_POSTFIX" scope="axis2" action="remove"/>
  5. Download WSO2 Developer Studio (version 3.8.0 is used here) from and open it by double clicking the file inside the downloaded folder. 

  6. Click Window > Open Perspective > Other to open the Eclipse perspective selection window. Alternatively, click the Open Perspective icon shown below at the top right corner.
    Image Added
  7. On the dialog box that appears, click WSO2 APIManager and click OK.
    Image Added

  8. On the APIM perspective, click the Login icon as shown below.
    Image Added
  9. On the dialog box that appears, enter the URL, username and password of the Publisher server.
    Image Added
  10. On the tree view that appears, expand the folder structure of the existing API.
  11. Right-click on the in sequence folder and click Import Sequence to import the sequence you create above.
    Image Added
  12. Browse to the TestSequence.xml file you created in step 4.
  13. Your sequence now appears on the Developer Studio console. Right-click on the imported sequence and click Commit File to push the changes to the Publisher server.
    Image Added

  14. Log back into the API Publisher, click the Edit link associated with the API and navigate to the Implement tab. Select the Enable Message Mediation check box and engage the In sequence that you created earlier.
    Image Added
  15. Save and Publish the API.
    You have created an API. Let's subscribe to the API and invoke it.
  16. Log in to the API Store and subscribe to the API.
    Image Added

  17. When prompted, choose to go to the My Subscriptions page and generate an access token to invoke the API.
    Image Added

  18. Click the API Console tab of your API.
    Image Added

  19. Note that the businessId is added in the UI as a parameter. Give a businessId and click Try it out to invoke the API.
    Image Added

  20. Note the response that you get. According to the mock backend used in this tutorial, you get the response Received Request.
    Image Added

In this tutorial, you mapped the URL pattern of the APIs in the Publisher with the endpoint URL pattern of a sample backend.