As an API developer, you would have designed and developed REST APIs that are intended to do some action over a particular resource, retrieval, or filtering of a collection of resources. These actions in the REST world are typically done with the help of a URI or query parameter. Understanding the usage of URI and query parameter is very important when developing an API.
URI Parameter
A URI is a resource identifier that can uniquely identify a specific instance of a resource. URI is part of the URL that is passed to get a unique resource.
eg: Get the details of a credit or debit card with unique id 738288383 and 489393 respectively.
http://abc.com/card/credit/738288383
http://abc.com/card/debit/489393
Query Parameter
Query parameters are used for filtering a resource collection. They are passed at the end of the URL after a question mark to sort, filter, or paginate the resource. In certain cases, they are also used along with the URI parameter.
**eg: **Get the credit cards that are in an active state and limit it by 100 cards.
http://abc.com/card/credit?status=active&limit=100
Now I think you might have got some idea around when to use URI and query parameter. In this article, I will demonstrate how to extract the URI and query parameter values inside the Kumologica API flow. For this, we will create two flows. The first flow will demonstrate how to access the URI parameter and the second flow will demonstrate how to access the query parameter.
Pre-Requisite
- Download and install the Kumologica designer.
- Install and configure AWS CLI
Note: For more details on installation refer to the following link.
#tutorial #integration #api #aws #rest #serverless #microservice #aws lambda #low code
