Multiple endpoints for REST API in Spring Boot

Question

I have two unique keys in a table: id and userId. I have to create a REST API in Spring to get user details if any of the two keys are given as path variables.

The challenge here is we have to create two different endpoints for getting user through id and getting a user through userId, but use same method for both. Also datatype of id is long and datatype of userId is String in my table.

So I am trying to do the following:

@RequestMapping(value = {"/{id}","/user/{id}"}, method=RequestMethod.GET)
public response getUser(@PathVariable("id") String id) {
    
}

But I am unable to figure out how to check whether I got id or userId inside the method. Also is this the right way to do it?

Vikram Singh Shekhawat · Accepted Answer · 2020-01-28 06:25:23Z

17

You can do this with single method like this:

@RequestMapping(value = {"/{id}", "/user/{userId}"}, method = RequestMethod.GET)
public void getUser(@PathVariable(value = "id", required = false) String id,
  @PathVariable(value = "userId", required = false) Long userId) {
    if (id != null) {
    //TODO stuff for id
   }
   if (userId != null) {
    //TODO stuff for userId
   }

}

answered Jan 28, 2020 at 6:25

Vikram Singh Shekhawat

8021 gold badge11 silver badges28 bronze badges

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

Comments

Hassam Abdelillah · Accepted Answer · 2020-01-27 20:39:36Z

1

I would use the @RequestMapping Multiple paths mapped to the same controller method possibility in such a manner.

I suspect that even if you refactor your code to call one single method, you still have to implement some logic to differentiate between the two parameters inside the controller method.

Besides, getUserById() signature is ambiguous. What the parameter id means the id or userId

Having two separate method for what you want to acheive would be more efficient two handle each case properly. Inside each controller method you can use a common logic for the two if you want.

@RequestMapping(value = "/user/{userId}", method=RequestMethod.GET)
public String getUserById(@PathVariable("userId") String userId){
   // Common login
}

@RequestMapping(value = "/id", method=RequestMethod.GET)
public String getUserByUserId(@PathVariable("userId") String userId){
   // Common login
}

You can even implement for each endpoint validators to check either you @PathVariable is valid or not in case of Long or String

Here are some references ref1, ref2

edited Jan 27, 2020 at 20:39

answered Jan 27, 2020 at 19:11

Hassam Abdelillah

2,3143 gold badges18 silver badges39 bronze badges

2 Comments

harv3 Over a year ago

doesn't it give error if I create two methods with same name

Hassam Abdelillah Over a year ago

You still can have one common shared business logic.

Jasper Huzen · Accepted Answer · 2020-01-27 20:42:28Z

1

Aren't you able to refactor the database to have only one id? That makes things clear and keeps the code cleaner.

If that is not possible you can create 2 methods with meaningful names.

// handles: /user/{entityId}
@RequestMapping(value = "/user/{entityId}", method=RequestMethod.GET)
public UserDto getUserByEntityId(@PathVariable("entityId") long entityId){
   // call service 
}

// handles: /user?userId={userId}
@RequestMapping(value = "/user", method=RequestMethod.GET)
public UserDto getUserByUserId(@RequestParam("userId", required=true) String userId){
   // call service 
}

You can discuss about about the correct names/signatures of the methods.

Another advantages of this approach is that you are able to add Swagger doc annotations to each of them.

edited Jan 27, 2020 at 20:42

answered Jan 27, 2020 at 20:35

Jasper Huzen

1,57312 silver badges26 bronze badges

Collectives™ on Stack Overflow

Multiple endpoints for REST API in Spring Boot

3 Answers 3

Comments

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related