Java REST API: Returning Multiple objects from API Method

Question

I am trying to return multiple objects (such as String, Boolean, MyOwnClass, etc) from a Java REST API Method using JAX-RS in Eclipse.

Here's what I have right now:

My API Method

@Path("/")
public class myAPI {

    @GET
    @Produces({ "application/xml", "application/json" })
    @Path("/getusers")
    public Response GetAllUsers() {

        //Data Type #1 I need to send back to the clients
        RestBean result = GetAllUsers();

        //Data Type #2 I need to send with in the response
        Boolean isRegistered = true;

        //The following code line doesn't work. Probably wrong way of doing it
        return Response.ok().entity(result, isRegistered).build();
    }
}

RestBean class:

public class RestBean {
    String status = "";
    String description = "";
    User user = new User();

   //Get Set Methods
}

So I'm basically sending two data types: RestBean and Boolean.

What's the right way of sending back a JSON response with multiple data objects?

A REST Response can only have 1 object at the top level, but there's no reason you can't have that top level object contain both your boolean and your RestBean. You would need to either construct it manually (using one of the JSONObject implementations) or make an annotated class that would produce the desired object — Tibrogargan
– Tibrogargan, Commented Mar 27, 2016 at 6:19
Is my implementation correct if I remove one return object from the last code line? return Response.ok().entity(result).build(); Is that correct? @Tibrogargan — Jay
– Jay, Commented Mar 27, 2016 at 6:20
I'm not sure if the entire implementation is correct, but that would be a correct use of entity() — Tibrogargan
– Tibrogargan, Commented Mar 27, 2016 at 6:24
That won't even compile.Boolean isRegistered = "true"; is a compile error. A string "true" is not a Boolean. — pczeus
– pczeus, Commented Mar 27, 2016 at 6:27
My bad @pczeus I edited in some code on StackOverflow. It's not in my actual code. Sorry about that — Jay
– Jay, Commented Mar 27, 2016 at 6:29

sisyphus · Accepted Answer · 2016-03-27 09:23:33Z

6

Firstly, Java conventions are that class names begin with an uppercase letter and method names with a lowercase letter. It's generally a good idea to follow them.

You need to wrap your response inside a single class, as @Tibrogargan suggests.

public class ComplexResult {
    RestBean bean;
    Boolean isRegistered;

    public ComplexResult(RestBean bean, Boolean isRegistered) {
        this.bean = bean;
        this.isRegistered = isRegistered;
    }
}

and then your resource looks like...

public Response getAllUsers() {
    RestBean restBean = GetAllUsers();
    Boolean isRegistered = true;
    final ComplexResult result = new ComplexResult(bean, isRegistered);

    return Response.ok().entity(Entity.json(result)).build();
}

What you really need to know, however, is what your response document should look like. You can only have a single response document - which is what the wrapper is for - and the way your wrapper is serialised affects how the parts of the document are accessed.

Note - you have your resource listed as being able to produce both XML and JSON and what I've done only works for json. You can get the framework to do all the content-negotiation heavy lifting for you, and that would probably be a good idea, by just returning the document type from the method rather than Response ...

public ComplexResponse getAllUsers() {
    ...
    return new ComplexResult(bean, isRegistered);

answered Mar 27, 2016 at 9:23

sisyphus

6,4121 gold badge27 silver badges36 bronze badges

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

1 Comment

Jay Over a year ago

Thank you for the detailed answer! :)

Collectives™ on Stack Overflow

Java REST API: Returning Multiple objects from API Method

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related