Path and Query Parameters in Kotlin API Requests

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 in Kotlin. 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: text 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: text 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. Query parameters are usually case-sensitive, meaning done=true and Done=true might be treated differently by some APIs. Be consistent with parameter names and values to avoid unexpected filtering issues. When using multiple query parameters in a URL, they should be separated by an ampersand & . Each query parameter is a key-value pair formatted as key=value . For example, if you want to both filter completed tasks and limit the results to the first 10, your URL might look like this: text http://localhost:8000/todos?done=true&limit=10 In this case, done=true and limit=10 are the query parameters, and they are separated by an & to indicate that both conditions should be applied to the API request.

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

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 with the OkHttp library in Kotlin:

Kotlin

import okhttp3.OkHttpClient
import okhttp3.Request

fun main() {
    val client = OkHttpClient()

    // Define the ID of the todo item you want to retrieve
    val todoId = 3

    // Build the request with the path parameter
    val request = Request.Builder()
        .url("http://localhost:8000/todos/$todoId")
        .build()

    // Make the GET request
    client.newCall(request).execute().use { response ->
        if (response.isSuccessful) {
            // Parse and print the JSON response
            response.body?.string()?.let { responseData ->
                println(responseData)
            }
        } else {
            println("Error fetching the todo with path parameter")
            println("Status Code: ${response.code}")
        }
    }
}

import okhttp3.OkHttpClient
import okhttp3.Request

fun main() {
    val client = OkHttpClient()

    // Define the ID of the todo item you want to retrieve
    val todoId = 3

    // Build the request with the path parameter
    val request = Request.Builder()
        .url("http://localhost:8000/todos/$todoId")
        .build()

    // Make the GET request
    client.newCall(request).execute().use { response ->
        if (response.isSuccessful) {
            // Parse and print the JSON response
            response.body?.string()?.let { responseData ->
                println(responseData)
            }
        } else {
            println("Error fetching the todo with path parameter")
            println("Status Code: ${response.code}")
        }
    }
}

In this example, the todoId is a path parameter specifying the to-do item with ID 3. If successful, the task details will be displayed in the console.

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.

Here's how you can filter to-do items that are completed and have titles starting with the prefix "c" in Kotlin: