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 the Requests-Scala library. 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.

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:

Plain text
Copy to clipboard
1http://localhost:8000/todos/3

In this case, 3 is the path parameter specifying the particular item you wish to access.

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:

Plain text
Copy to clipboard
1http://localhost:8000/todos?done=true

Here, done=true is the query parameter filtering the results to include only tasks that are marked as completed.

Before jumping into implementing these parameters using Requests-Scala, ensure your setup is ready. Start by importing the necessary packages and defining the base URL:

Scala
Copy to clipboard
1import requests.*
2import scala.util.{Failure, Success, Try}
3import ujson.*
4
5val baseUrl = "http://localhost:8000"

Now we're all set to dive into the code examples!

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:

Scala
Copy to clipboard
1val todoId = 3
2
3val response = Try(requests.get(s"$baseUrl/todos/$todoId"))
4
5response match
6  case Success(resp) if resp.statusCode == 200 =>
7    val todo = ujson.read(resp.text())
8    println(s"ID: ${todo("id")}")
9    println(s"Title: ${todo("title")}")
10    println(s"Description: ${todo("description")}")
11    println(s"Done: ${todo("done")}")
12
13  case Success(resp) =>
14    println("Error fetching the todo with path parameter")
15    println(s"Status Code: ${resp.statusCode}")
16    println(s"Error Details: ${resp.text()}")
17
18  case Failure(exception) =>
19    println(s"HTTP request failed: ${exception.getMessage}")

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:

Plain text
Copy to clipboard
1ID: 3
2Title: Finish project report
3Description: Summarize Q4 performance metrics
4Done: False

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:

Scala
Copy to clipboard
1val response = Try(requests.get(s"$baseUrl/todos", params = Map("done" -> "true")))
2
3response match
4  case Success(resp) if resp.statusCode == 200 =>
5    val todos = ujson.read(resp.text()).arr
6    todos.foreach { todo =>
7      println(s"- ${todo("id")}: ${todo("title")}")
8    }
9
10  case Success(resp) =>
11    println("Error fetching todos with query parameter")
12    println(s"Status Code: ${resp.statusCode}")
13    println(s"Error Details: ${resp.text()}")
14
15  case Failure(exception) =>
16    println(s"HTTP request failed: ${exception.getMessage}")

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:

Plain text
Copy to clipboard
1- 2: Call mom
2- 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":

Scala
Copy to clipboard
1val params = Map("done" -> "true", "title" -> "c")
2val response = Try(requests.get(s"$baseUrl/todos", params = params))
3
4response match
5  case Success(resp) if resp.statusCode == 200 =>
6    val todos = ujson.read(resp.text()).arr
7    todos.foreach { todo =>
8      println(s"- ${todo("id")}: ${todo("title")}")
9    }
10
11  case Success(resp) =>
12    println("Error fetching todos with multiple query parameters")
13    println(s"Status Code: ${resp.statusCode}")
14    println(s"Error Details: ${resp.text()}")
15
16  case Failure(exception) =>
17    println(s"HTTP request failed: ${exception.getMessage}")

In this example, the query parameters done=true and title=c are used together to filter the results. The URL in this request will look like http://localhost:8000/todos?done=true&task=c, retrieving items that are both completed and begin with "c". If successful, the output will be:

Plain text
Copy to clipboard
1- 2: Call mom

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!