Dynamic @RequestParam in @RestController

Question

I have a controller:

@RestController
@RequestMapping(value = UserRestController.REST_URL, produces = 
MediaType.APPLICATION_JSON_VALUE)
public class UserRestController {

static final String REST_URL = "/customers";

@GetMapping
public List<User> getAll() {
    return service.getAll();
  }
}

It succesfully handle such requests,as:

GET:    /customers/

And I want to get users by some parameters.For example, email:

GET:   /customers?email=someemail@gmail.

I tried:

@GetMapping("/")
public User getByEmail(@RequestParam(value = "email") String email) {
    return super.getByEmail(email);
}

and expectedly I receive an exception, as "/" is already mapped on getAll-class. Is there any ways to solve this problem?

try this `@GetMapping("/email") public User getByEmail(@RequestParam(value = "email") String email) { return super.getByEmail(email); }` — Rahul Agrawal, Feb 19 '20 at 12:36
This way is working, but it mapped on /customers/email?email=someemail@gmail. And I need exactly /customers?email=someemail@gmail. — Jelly, Feb 19 '20 at 12:42

Dinesh Shekhawat · Answer 1 · 2020-02-19T12:56:41.237

2

@GetMapping
public Object get((@RequestParam(value = "email", required = false) String email) {
    if (email != null && !email.isEmpty()) { 
     return super.getByEmail(email);
    } else {
      return service.getAll();
    }  
}

edited Feb 19 '20 at 12:56

answered Feb 19 '20 at 12:35

Dinesh Shekhawat

504
6
13

I tried this. it returns 404-Error for /customers&email=someemail@gmail.com And 404 - for /customers/ – Jelly Feb 19 '20 at 12:51
1

Do you mean /customers?email=someemail@gmail.com – Dinesh Shekhawat Feb 19 '20 at 12:52
Yes. Sorry! I made a mistake. Responce with 405 when I try /customers&email=someemail@gmail.com – Jelly Feb 19 '20 at 12:54
1

Is it working now? I have added required false in @RequestParam Annotation – Dinesh Shekhawat Feb 19 '20 at 12:55
1

You added the required = false in @RequestParam? – Dinesh Shekhawat Feb 19 '20 at 12:58
I added required = false and GET: /customers/ now is workig well. But /customers?email=someemail@gmail.com returns 405 – Jelly Feb 19 '20 at 13:04
And one more question, please. If need to use other parameters (besides), could I use something like public List getByEmailOrAll(@RequestParam(value = "email", required = false) String email, @RequestParam(value = "phone" , required = false) String phone) – Jelly Feb 19 '20 at 13:27
Absolutely, give it a shot. – Dinesh Shekhawat Feb 19 '20 at 13:29

score 2 · Answer 2 · answered Feb 19 '20 at 12:57

2

You have to modify your current

@GetMapping
public List<User> getAll() {
    return service.getAll();
  }
}

method and add the email as a request parameter if you want to keep the URL mapping the same. So it will look like:

@GetMapping
public List<User> getAll(@RequestParam(value = "email", required = false) String email) {
    if (!StringUtils.isempty(email)) {
        return super.getByEmail(email);
    } else {
        return service.getAll();
    }
}

answered Feb 19 '20 at 12:57

mherBaghinyan

476
5
13

I tried. GET: /customers/ now is workig well. But GE: /customers?email=someemail@gmail.com returns 405 – Jelly Feb 19 '20 at 13:06

Dynamic @RequestParam in @RestController

2 Answers2