|
|
Introduction to Path and Query Parameters
Welcome to another lesson of this course. In our previous lessons, we established a foundation by learning about
RESTful APIs
and making
GET
requests with Dart's
http
package. Now, we will shift our focus to
path
and
query parameters
, essential tools for refining API requests and fetching specific data.
Path and query parameters play a crucial role in making your API requests more precise and efficient. Imagine you are shopping online: selecting a specific item using its ID is akin to a path parameter, while filtering items by categories like price or color resembles query parameters. In this lesson, we'll explore these concepts with practical examples, empowering you to extract just the information you need from an API.
Understanding Path Parameters
Path parameters are part of the URL used to access specific resources within an API, acting like unique identifiers. For example, if you want to retrieve a to-do item with ID 3, the URL would be structured as follows:
In this case,
3
is the path parameter specifying the particular item you wish to access.
Understanding Query Parameters
Query parameters are added to the URL after a
?
to filter or modify the data returned by the API. They are formatted as key-value pairs. For instance, if you want to list only the completed to-do tasks, your request would be:
Here,
done=true
is the query parameter filtering the results to include only tasks that are marked as completed.
Setup Recap
Before jumping into implementing these parameters using Dart's
http
package, let's make sure everything's set up. Start by importing the
http
package,
convert
for JSON decoding, and ensure your
main
function is marked as
async
to handle asynchronous operations:
Now we're all set to dive into the code examples!
Fetching Data with Path Parameters
Path parameters are used to target specific resources within an API, allowing you to access individual items directly. They are appended directly to the endpoint URL. For instance, if you want to fetch details of a specific to-do item using its ID, you'd use a path parameter.
Here's a practical example using ID 3:
In this example, the
todoId
is a path parameter specifying the to-do item with ID 3, and the full URL looks like
http://localhost:8000/todos/3
. If successful, you'll get an output displaying the task details:
This output confirms that the specific item was retrieved, demonstrating how path parameters enable you to access individual resources accurately.
Filtering Data with Query Parameters
Query parameters are attached to the URL to filter or modify the results returned by the API. They're especially useful for searching or narrowing down data without altering the overall resource structure.
Let's filter the to-do items to list only those marked as done:
Here, the query parameter
done=true
is used to filter the results. The full URL in this case looks like
http://localhost:8000/todos?done=true
, focusing only on completed tasks. If successful, the output will list the tasks that are marked as done, emphasizing how query parameters can streamline outputs by highlighting specific criteria:
Using Multiple Query Parameters
To refine data retrieval further, you can combine multiple query parameters. For instance, you might want to fetch to-do items that are marked as done and also have titles that start with a specific prefix.