Add Request Query String Parameters
How to add request query string Parameters to my Azure API operation to make it more user friendly?
If your API operation uses URL template parameters, the client system must call it with parameter values specified in the correct position, like:
The above URL is nice and short. But it confuses users: Is the rate for from USD to EUR or from EUR to UDS?
To avoid he confusion, you change the URL signature to use query string parameters, like
One big advantage of query string parameters is that their position order is not important. So the following 3 URL are identical:
https://.../exchange-rate?from=USD&to=EUR&date=2020-10-10 https://.../exchange-rate?to=EUR&date=2020-10-10&from=USD https://.../exchange-rate?date=2020-10-10&from=USD&to=EUR
Here are steps to create query string 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 #2".
3. Enter the following to create the operation:
Display name: Get Exchange Rate #2 Name: get-exchange-rate-2 HTTP verb: GET /exchange-rate Description: Get Exchange Rate #2
4. Click "Query" tab. You see parameter fields displayed.
5. Click "ADD QUERY PARAMETER" repeatedly to enter 3 parameters:
NAME DESCRIPTION TYPE VALUES REQUIRED from From-currency code string USD x to To-currency code string EUR x date Date othe order date 2020-10-10 x
The picture below shows you how to create request query string parameters for an API operation:
2018-03-24, 2757👍, 0💬
How to read RSS validation errors at w3.org? If your RSS feed has errors, the RSS validator at w3.or...
How to use the "find-and-replace" Policy Statement for an Azure API service operation? The "find-and...
How to create a new API on the Publisher Portal 2017 version of an Azure API Management Service? If ...
How to add request URL Template Parameters to my Azure API operation 2017 version to make it more us...
What is Azure API Management Gateway? Azure API Management Gateway is the Azure Web server that serv...