How to use Objects as parameters in REST webservices

Question

I am writing a rest service looking something like this:

@POST
@Consumes("application/json")
public void save(@QueryParam("firstName") String firstName, @QueryParam("lastName") String lastName, @QueryParam("email") String email) {
    User user = new User(firstName, lastName, email);
    db.createUser(user);
}

I would like to be able to have something like an object parameter:

@POST
@Consumes("application/json")
public void save(@ObjectParam User user) {
    db.createUser(user);
}

It would be nice not having to specify what parameters i am expecting or writing my own object parser.

@ObjectParam doesn't exist, but i would like something like that. Right now i don't have a way to use an object as parameter — kitkong
– kitkong, Commented Aug 3, 2015 at 21:08
See @WestonJones answer - everything you include in the parameter list is seen as message body - annotations are only needed if you want to have further parameters which are present as path or query params. — Smutje
– Smutje, Commented Aug 4, 2015 at 6:29

Weston Jones · Accepted Answer · 2015-08-03 20:00:32Z

1

This should be sufficient

@POST
@Consumes("application/json")
public void save(User user) {
    db.createUser(user);
}

It should map the object to JSON as long as you include a JSON object in your POST that matches.

answered Aug 3, 2015 at 20:00

Weston Jones

1614 bronze badges

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

Comments

morsor · Accepted Answer · 2015-08-04 06:27:04Z

0

In Spring REST, one may do the following:

@RequestMapping(value = "/", method = RequestMethod.POST)
public ResponseEntity<Car> update(@RequestBody Car car) {
    ...
}

answered Aug 4, 2015 at 6:27

morsor

1,32314 silver badges32 bronze badges

Collectives™ on Stack Overflow

How to use Objects as parameters in REST webservices

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related