How to set default value to a path variable?

Question

@GetMapping(value = "/{locale}", produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<String> getLocale(@PathVariable("locale") String locale) {
    return new ResponseEntity<>(locale, HttpStatus.OK);
}

I want if locale is null, I can set a default value "english" in it.

https://stackoverflow.com/questions/41620395/spring-set-default-pathvariable — bananas, Mar 15 '20 at 08:04

score 2 · Answer 1 · answered Mar 17 '20 at 08:33

By default PathVariable is required but you can set it optional as :

@GetMapping(value = "/{locale}", produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<String> getLocale(@PathVariable(name="locale", required= 
false) String locale) {
//set english as default value if local is null   
locale = locale == null? "english": locale;
return new ResponseEntity<>(locale, HttpStatus.OK);
}

score 0 · Answer 2 · answered Mar 15 '20 at 07:05

0

You can use required false attribute and then can check for null or empty string value. Refer this thread

getLocale(@PathVariable(name ="locale", required= false) String locale

And then check for null or empty string.

answered Mar 15 '20 at 07:05

Alien

15,141
6
37
57

score 0 · Answer 3 · answered Mar 16 '20 at 07:25

You cannot provide default value to spring path variable as of now.

You can do the following obvious thing:

@GetMapping(value = "/{locale}", produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<String> getLocale(@PathVariable("locale") String locale) {
    locale = locale == null? "english": locale;
    return new ResponseEntity<>(locale, HttpStatus.OK);
}

But more appropriate is to use Spring i18n.CookieLocaleResolver, so that you do not need that path variable anymore:

    <bean id="localeResolver" class="org.springframework.web.servlet.i18n.CookieLocaleResolver">
        <property name="defaultLocale" value="en"/>
    </bean>

score 0 · Answer 4 · answered Feb 17 '23 at 17:48

We can set the required property of @PathVariable to false to make it optional.

But we will also need to listen for requests that are coming without path variable.

@GetMapping(value = { "/{locale}", "/" }, produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<String> getLocale(@PathVariable("locale") String locale) {
    return new ResponseEntity<>(locale, HttpStatus.OK);
}

score -1 · Answer 5 · answered Mar 16 '20 at 07:49

-1

You just need to provide default value

@GetMapping(value = "/{locale}", produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<String> getLocale(@PathVariable("locale", defaultValue="english") String locale) {
    return new ResponseEntity<>(locale, HttpStatus.OK);
}

answered Mar 16 '20 at 07:49

Swarit Agarwal

2,520
1
26
33

3

there is no `defaultValue` in `@PathVariable` – Nonika Mar 16 '20 at 08:21
there is nothing like defaultValue – Vipul Paralikar Oct 30 '20 at 20:28

How to set default value to a path variable?

5 Answers5