Operation Setting: 'Rewrite URL template'

Q

How to use the API operation setting "Rewrite URL template"?

✍: FYIcenter.com

A

The API operation setting "Rewrite URL template" is used to overide the "URL template" setting, when constructing the final URL to call the backend service.

By default, Azure will construct the final URL by appending the URL template defined at the operation level to the backend Web service URL defined at the API level.

For example, if you create an API with the following settings:

Web service URL: http://dev.fyicenter.com/services
Web API URL suffix: first
Your API service URL: https://fyicenter.azure-api.net/first

Then you add an operation with the following settings, leaving the "Rewrite URL" field empty:

HTTP verb: POST
URL template: /users
Rewrite URL template: 

When client system calls your Azure API service operation at:

https://fyicenter.azure-api.net/fist/users

Azure will forward the call to your backend service with this final URL:

http://dev.fyicenter.com/services/users

Constructed by:
<Web service URL> + <URL template>
= "http://dev.fyicenter.com/services" + "/users"

But if you set "Rewrite URL" field to "/users", like:

HTTP verb: POST
URL template: /users
Rewrite URL template: /profiles

Azure will forward the call to your backend service with this final URL:

http://dev.fyicenter.com/services/users

Constructed by:
<Web service URL> + <Rewrite URL template>
= "http://dev.fyicenter.com/services" + "/profiles"

 

Using Azure API Management Publisher Portal

⇒⇒Microsoft Azure API Management Tutorials

2017-09-23, 114👍, 0💬