Handling Path Variables and Query Parameters in Spring Boot

Introduction

Welcome! In this lesson, we'll dive into Handling Path Variables and Query Parameters in Spring Boot . You've already learned how to create REST endpoints and return JSON responses. Now, we’ll extend that knowledge by exploring how to handle path variables and query parameters in your APIs. Path variables and query parameters are crucial for passing information and filtering data in RESTful APIs. These tools will make your endpoints more dynamic and powerful. Let’s get started!

Understanding Path Variables

In previous lessons, we used hardcoded endpoints like /recipes/american-sandwich . As your application grows and you have a database with thousands of recipes, defining a separate endpoint for each recipe becomes impractical. Instead, you can use path variables, such as: /recipes/{recipeId} . Here, recipeId is a dynamic part of the URL that gets passed to your methods. For example: When someone requests /recipes/123, the recipeId variable will take the value 123 . When someone requests /recipes/pizza-pepperoni, the recipeId variable will take the value pizza-pepperoni . You can also have paths with multiple path variables. For instance, by introducing recipe categories, you can have the following paths: /categories/{recipeCategory} /categories/{recipeCategory}/recipes/{recipeId} This hierarchical structure makes your API more organized and reflective of your domain model.

Path Variables Example

Imagine you have a collection of recipes, and you want to retrieve a specific recipe by its unique ID. Here’s how you can implement this in Spring Boot Kotlin: Kotlin @GetMapping("/recipes/{recipeId}") fun getRecipeById(@PathVariable recipeId: Long): Recipe {return recipeRepository.findById(recipeId) ?: throw IllegalArgumentException("Recipe not found")} Here’s what’s happening: @GetMapping("/recipes/{recipeId}) : Maps HTTP GET requests to /recipes/{recipeId} . {recipeId} is a path variable. @PathVariable recipeId: Long : Binds the path variable recipeId from the URL to the method parameter. The method interacts with recipeRepository to find a recipe by its ID. If no matching recipe is found, it throws an IllegalArgumentException . Path variables make your URLs more dynamic and informative.

Join the 1M+ learners on CodeSignal

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

Combining Path Variables and Query Parameters

You can combine path variables and query parameters in a single endpoint. This is useful when you need to identify a specific resource category and apply some filters or additional criteria.

Here’s an endpoint that retrieves recipes by category and allows filtering for a specific dietary preference:

Kotlin

@GetMapping("/category/{recipeCategory}")
fun getRecipesByCategoryAndDietaryPreference(
    @PathVariable recipeCategory: String,
    @RequestParam dietaryPreference: String?
): List<Recipe> {
    val recipes = recipeRepository.findByCategory(recipeCategory)
    
    return dietaryPreference?.let { preference ->
        recipes.filter { recipe -> recipe.dietaryPreference.equals(preference, ignoreCase = true) }
    } ?: recipes
}

@GetMapping("/category/{recipeCategory}")
fun getRecipesByCategoryAndDietaryPreference(
    @PathVariable recipeCategory: String,
    @RequestParam dietaryPreference: String?
): List<Recipe> {
    val recipes = recipeRepository.findByCategory(recipeCategory)
    
    return dietaryPreference?.let { preference ->
        recipes.filter { recipe -> recipe.dietaryPreference.equals(preference, ignoreCase = true) }
    } ?: recipes
}

This example shows how combining path variables and query parameters can create powerful and flexible endpoints. For instance, a request to /category/Italian?dietaryPreference=vegan will retrieve all recipes within the "Italian" category and filter them for those labeled as "vegan".

Here’s what’s happening in the code:

@GetMapping("/category/{recipeCategory}"): Maps HTTP GET requests to /category/{recipeCategory}.
@PathVariable recipeCategory: String: Binds the path variable recipeCategory from the URL to the method parameter.
@RequestParam dietaryPreference: String?: Binds the query parameter dietaryPreference, which is optional, to the method parameter.
The method retrieves recipes by category from recipeRepository.
If dietaryPreference is provided, it filters the recipes by matching the dietary preference. If not, it returns all recipes within the specified category.

Introduction

Understanding Path Variables

Path Variables Example

Join the 1M+ learners on CodeSignal

Named Path Variables

Understanding Query Parameters

Query Parameters Example

Making Query Parameters Optional

Named Query Parameters

Combining Path Variables and Query Parameters

Summary