Spring Top

Get started with Spring 5 and Spring Boot 2, through the reference Learn Spring course:


1. Overview

In this quick tutorial, we’ll explore the differences between Spring's @RequestParam and @PathVariable annotations.

@RequestParam and @PathVariable can both be used to extract values from the request URI, but they are a bit different.

2. Query Parameter vs URI Path

While @RequestParams extract values from the query string, @PathVariables extract values from the URI path:

public String getFooById(@PathVariable String id) {
    return "ID: " + id;

Then, we can map based on the path:

ID: abc

And for @RequestParam, it will be:

public String getFooByIdUsingQueryParam(@RequestParam String id) {
    return "ID: " + id;

Which would give us the same response, just a different URI:

ID: abc

3. Encoded vs Exact Value

Because @PathVariable is extracting values from the URI path, it’s not encoded. On the other hand, @RequestParam is.

Using the previous example, ab+c will return as-is:

ID: ab+c

But for a @RequestParam request, the parameter is URL decoded:

ID: ab c

4. Optional Values

Both @RequestParam and @PathVariable can be optional.

We can make @PathVariable optional by using the required attribute starting with Spring 4.3.3:

@GetMapping({"/myfoos/optional", "/myfoos/optional/{id}"})
public String getFooByOptionalId(@PathVariable(required = false) String id){
    return "ID: " + id;

Which, then, we can do either:

ID: abc


ID: null

For @RequestParam, we can also use the required attribute.

Note that we should be careful when making @PathVariable optional, to avoid conflicts in paths.

5. Conclusion

In this article, we learned the differences between @RequestParam and @PathVariable.

The full source code for the examples can be found over on GitHub.

Spring bottom

Get started with Spring 5 and Spring Boot 2, through the Learn Spring course:

Comments are closed on this article!