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:
http://localhost:8000/todos/3
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:
http://localhost:8000/todos?done=true
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:
import 'dart:convert';import 'package:http/http.dart' as http;void main() async { // Base URL for the API final String baseUrl = "http://localhost:8000"; // Rest of the code...}
Now we're all set to dive into the code examples!
Fetching Data with Path Parameters
Join the 1M+ learners on CodeSignal
Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal
text
http://localhost:8000/todos/3
text
http://localhost:8000/todos?done=true
Dart
import 'dart:convert';import 'package:http/http.dart' as http;void main() async { // Base URL for the API final String baseUrl = "http://localhost:8000"; // Rest of the code...}
Filtering Data with Query Parameters
Using Multiple Query Parameters
Summary and Preparing for Practice
In this lesson, you’ve learned how to work with both path and query parameters to refine API requests. Path parameters allow you to pinpoint specific resources, whereas query parameters tailor the results based on defined conditions. Together, they provide a robust mechanism for fetching targeted and detailed information from an API.
You are now prepared to tackle the practice exercises, where you will apply these concepts and explore variations to further reinforce your understanding. As you proceed, remember how these skills can be essential for effective API interaction, laying the groundwork for more advanced operations in future lessons. Keep up the momentum as you continue to advance through the course!
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:
Dart
// Define the ID of the todo item you want to retrievefinal int todoId = 3;// Make a GET request using the path parameter for the specific todo itemfinal response = await http.get(Uri.parse('$baseUrl/todos/$todoId'));// Check if the request was successfulif (response.statusCode == 200) { // Parse the JSON response to get details of the todo item var todo = jsonDecode(response.body); // Print all details of the todo item print("ID: ${todo['id']}"); print("Title: ${todo['title']}"); print("Description: ${todo['description']}"); print("Done: ${todo['done']}");} else { // Handle potential errors print("Error fetching the todo with path parameter"); print("Status Code: ${response.statusCode}"); print("Error Details: ${response.body}");}
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.
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:
Dart
// Fetch todos with a query parameter to filter for completed itemsfinal response = await http.get(Uri.parse('$baseUrl/todos?done=true'));// Check if the request was successfulif (response.statusCode == 200) { // Parse the JSON response to get the list of completed todos List todos = jsonDecode(response.body); // Print the todo items for (var todo in todos) { print("- ${todo['id']}: ${todo['title']}"); }} else { // Handle potential errors print("Error fetching todos with query parameter"); print("Status Code: ${response.statusCode}"); print("Error Details: ${response.body}");}
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:
text
- 2: Call mom- 4: Workout
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.
Here's how you can filter to-do items that are completed and have titles starting with the prefix "c":
Dart
// Define the multiple query parameters using a mapfinal Map<String, String> params = {"done": "true", "title": "c"};// Use the replace method to add query parameters to the URLfinal response = await http.get(Uri.parse('$baseUrl/todos').replace(queryParameters: params));// Check if the request was successfulif (response.statusCode == 200) { // Parse the JSON response to get the filtered list of todos List todos = jsonDecode(response.body); // Print the filtered todo items for (var todo in todos) { print("- ${todo['id']}: ${todo['title']}"); }} else { // Handle potential errors print("Error fetching todos with multiple query parameters"); print("Status Code: ${response.statusCode}"); print("Error Details: ${response.body}");}
In this example, the params map is used to define multiple query parameters, where each key-value pair represents a parameter and its value. The replace method is then used to append these query parameters to the base URL. The URL in this request will look like http://localhost:8000/todos?done=true&title=c, retrieving items that are both completed and begin with "c". If successful, the output will be:
text
- 2: Call mom
By using the params map and the replace method, you can efficiently manage and apply multiple query parameters to your API requests.
