Add Request URL Template Parameters

Q

How to add request URL Template Parameters to my Azure API operation to make it more user friendly?

✍: FYIcenter.com

A

If your API Operation requires some key parameters, you put them as template parameters in the URL template of the operation.

Using template parameters reduces the need for providing parameters in the request body and simplifies the request.

If you want to build an API operation to returning the exchange rate of given currencies, you need 3 input parameters from the request: from-currency, to-currency and date.

You can design your API operation with no template parameter and put all 3 parameters in the request body:

URL template: /exchange-rate
Request body: from=USD&to=EUR&date=2020-10-10

You can design your API operation with template parameters and no request body::

URL template: /exchange-rate/{from}/{to}/{date}
Request body: none

Obviously, the second design with template parameter is much easier for client systems to call:

https://.../exchange-rate/USD/EUR/2020-10-10

Here are steps to create template parameters:

1. Go to the publisher portal of the API Management Service.

2. Open the "First API" and add a new operation "Get exchange rate".

3. Enter the following to create the operation:

HTTP verb: GET
URL template: /exchange-rate/{from}/{to}/{date}
Rewrite URL template: /currency-exchange/{from}/{to}/{date}
Display name: Get Exchange Rate

The picture below shows you how to create Request URL template parameters for an API operation:
API Operation - Request URL Template Parameters

 

Making API More User Friendly

⇒⇒Microsoft Azure API Management Tutorials

2017-09-23, 118👍, 0💬