List of possible values for particular path variable in Spring MVC

Question

Consider three REST resources:

/persons/id/{id}
/persons/code/{code}
/persons/email/{email}

I want to make one method in a Spring MVC controller to handle these requests:

@RequestMapping("/persons/{searchField}/{searchValue}")
public Person search(@PathVariable field, @PathVariable value) {
...
}

The question: is there any elegant way to restrict searchField's variable list of values on the annotation level except just by checking them in the method search?

switch (field) {
  case "id": ...
  case "code": ...
  ...
  default: // not found exception??
}

The elegant way is to define a method for each acceptable value of searchField, as noted by Sotirios above — holtc
– holtc, Commented Sep 16, 2016 at 14:40
how about @RequestMapping("/persons) and use RequestParam instead of PathVariable? — Aroniaina
– Aroniaina, Commented Sep 16, 2016 at 14:42
@SotiriosDelimanolis I actually can do it easily, see my answer :-D — Andremoniy
– Andremoniy, Commented Sep 16, 2016 at 14:43

Andremoniy · Accepted Answer · 2021-03-30 09:35:07Z

19

It can be easily done using regular expressions in the mapping:

@RequestMapping("/persons/{searchField:id|code|email}/{searchValue}")

edited Mar 30, 2021 at 9:35

answered Sep 16, 2016 at 14:43

Andremoniy

35.2k25 gold badges143 silver badges259 bronze badges

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

1 Comment

Cililing Over a year ago

Worth to mention, with such mapping the swagger (if someone uses it) will generate a request METHOD /persons/{searchField} (with no info about possible values that'll be matched), so for generating documentation we would need to add additional @Schema parameters.

Andreas Guther · Accepted Answer · 2017-08-22 21:46:13Z

2

You can also use a enum as type for your @PathVariable that will make Spring to limit the accepeted request values to the values of the enum

answered Aug 22, 2017 at 21:46

Andreas Guther

4325 silver badges8 bronze badges

Collectives™ on Stack Overflow

List of possible values for particular path variable in Spring MVC

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related