Is it possible to validate @RequestParam in Spring MVC REST endpoint?

Question

In Jersey 2 it is possible to do this:

@GET @PATH("user/{email}") public IDto getUser(@NotNull @Email @PathParam("email") String validEmail) { return userManagementService.findUserByEmail(validEmail); }

But I cannot make something similar to work in Spring MVC, it seems that the validation is only done when providing an object in @RequestBody or using an SpringMVC Form, for example the following won't work:

@RequestMapping(value="/user/{email}", method = RequestMethod.GET) public @ResponseBody IDto getUser(@NotNull @Email @PathVariable String validEmail) { return userManagementService.findUserByEmail(validEmail); }

There are other similar questions, but those seem to be oriented to Spring MVC UI applications, in my case it is only a REST API which returns JSON response so I don't have any View to map/bind to the controller.

You minimally need to annotate with @Valid, though this might only work if you have a model class and not just a String. — beerbajay
– beerbajay, Commented Jul 5, 2014 at 10:09
Yes, the question is about simple parameters not about POJO objects as input, for that I know about the @Valid annotation that will use the bean validation from the annotations in the class. But that is not the feature I am asking for — raspacorp
– raspacorp, Commented Jul 11, 2014 at 16:09

Dormouse · Accepted Answer · 2022-08-23 10:35:10Z

Seems it is possible, using @Validated.

Here's an example.

Based on OP's question, this should work:

@RestController @Validated public class MyController { @GetMapping(value="/user/{email}") public @ResponseBody IDto getUser(@NotNull @Email @PathVariable String validEmail) { return userManagementService.findUserByEmail(validEmail); } }

In plain Spring implementations, it may be required to manually register the validator bean:

@Bean public MethodValidationPostProcessor methodValidationPostProcessor() { return new MethodValidationPostProcessor(); }

In addition to the link, can you please add a snippet so it is easier to understand the answer even if the link gets broken?
Adding @Validated to the required controller class or method is enough to trigger the validation.
In my case Is not working by default with @Validated annotation.
In plain Spring implementations, it may be required to register the validator bean.

M. Justin · Accepted Answer · 2024-03-27 20:43:28Z

5

Simply add @Validated annotation at the top of your class.
Put whatever annotations for validations (@NotBlank, @Min(1), etc.) before the @RequestParam annotation in your method signature.

edited Mar 27, 2024 at 20:43

M. Justin

23.2k12 gold badges133 silver badges168 bronze badges

answered Jul 17, 2020 at 1:50

Hani

1,3931 gold badge14 silver badges11 bronze badges

3 Comments

M. Justin Over a year ago

"Put whatever annotations for validations ([…]) before the @RequestParam annotation in your method signature." — I just tested this, and it doesn't cause it to be validated. It would surprise me a great deal to learn that the framework cared the order in which these annotations were applied to the method parameter.

M. Justin Over a year ago

Actually, now that I reread it: were those supposed to be "do 1 or 2" or "do both"?

Hani Over a year ago

@M.Justin It's both.

fabfas · Accepted Answer · 2020-07-17 02:03:13Z

The validated annotation from the org.springframework.validation.annotation.Validated package to validate a @PathVariable. Make sure the class annotated with @Validated.

@GetMapping("/name-for-day/{dayOfWeek}") public String getNameOfDay(@PathVariable("dayOfWeek") @Min(1) @Max(7) Integer dayOfWeek) { return dayOfWeek + ""; }

mahfuj asif · Accepted Answer · 2020-06-30 04:06:11Z

Controller should be annotated with spring's @Validated

So update your code with

@Validated @RequestMapping(value="/user/{email}", method = RequestMethod.GET) public @ResponseBody IDto getUser( @NotNull @Email @PathVariable String validEmail) { return userManagementService.findUserByEmail(validEmail); }

Neil McGuigan · Accepted Answer · 2014-07-22 18:18:54Z

As far as I can tell, you cannot do this out-of-the-box with Spring.

Options:

Use a regular expression:

@RequestMapping(value="/user/{email:SOME_REXEXP}", method = RequestMethod.GET) public @ResponseBody IDto getUser(@PathVariable String validEmail) { return userManagementService.findUserByEmail(validEmail); }

Use Hibernate Validator to validate the method. Either call the validator manually, or make Spring call it for you using AOP. See https://github.com/gunnarmorling/methodvalidation-integration

Collectives™ on Stack Overflow

Is it possible to validate @RequestParam in Spring MVC REST endpoint?

5 Answers 5

4 Comments

3 Comments

Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

4 Comments

3 Comments

Comments

Comments

Comments

Linked

Related