Spring @RequestMapping with optional parameters

Question

I have problem in my controller with optional params in requestmapping, look on my controller below:

@GetMapping(produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<List<Books>> getBooks() {
    return ResponseEntity.ok().body(booksService.getBooks());
}

@GetMapping(
    produces = MediaType.APPLICATION_JSON_VALUE,
    params = {"from", "to"}
)
public ResponseEntity<List<Books>>getBooksByFromToDate(
    @RequestParam(value = "from", required = false) String fromDate,
    @RequestParam(value = "to", required = false) String toDate) 
{
    return ResponseEntity.ok().body(bookService.getBooksByFromToDate(fromDate, toDate));
}

Now, when I send request like:

/getBooks?from=123&to=123

it's ok, request goes to "getBooksByFromToDate" method but when I use send something like:

/getBooks?from=123

or

/getBooks?to=123

it goes to "getAlerts" method

Is it possible to make optional params = {"from", "to"} in @RequestMapping ? Any hints?

Hi, I'm also looking for same, if you got a solution, please update — VRadhe
– VRadhe, Commented Feb 3, 2020 at 7:25

kakabali · Accepted Answer · 2018-03-21 11:04:26Z

10

Use the default values. Example:-

@GetMapping(produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<List<Books>> getBooksByFromToDate(@RequestParam(value = "from", required = false, defaultValue="01/03/2018") String fromDate, @RequestParam(value = "to", required = false, defaultValue="21/03/2018") String toDate) { 
.... 
}

edited Mar 21, 2018 at 11:04

answered Mar 21, 2018 at 10:49

kakabali

4,0812 gold badges34 silver badges60 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Community · Accepted Answer · 2020-06-20 09:12:55Z

2

Just use defaultValue as explained in the Spring's docs:

defaultValue

The default value to use as a fallback when the request parameter is not provided or has an empty value.

edited Jun 20, 2020 at 9:12

CommunityBot

11 silver badge

answered Mar 21, 2018 at 10:18

GhassanMoussaif

212 bronze badges

Collectives™ on Stack Overflow

Spring @RequestMapping with optional parameters

2 Answers 2

Comments

defaultValue

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

defaultValue

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related