REST Web service JSON format

Question

I am trying to create a REST web service that returns the details of a user.

Here is my code:

//Actual web service methods implemented from here
    @GET
    @Path("login/{email}/{password}")
    @Produces("application/json")
    public Tourist loginUser(@PathParam("email") String email, @PathParam("password") String password) {
        List<Tourist> tourists = super.findAll();
        for (Tourist tourist : tourists) {
            if (tourist.getEmail().equals(email) && tourist.getPassword().equals(password)) {
                return tourist;
            }
        }
        //if we got here the login failed
        return null;
    }

This produces the following JSON:

{
    "email": "[email protected]",
    "fname": "Adrian",
    "lname": "Olar",
    "touristId": 1
}

What i need is:

    {"tourist":{
            "email": "[email protected]",
            "fname": "Adrian",
            "lname": "Olar",
            "touristId": 1
        }
    }

What would i need to add to my code to produce this?

That's not a valid JSON so you can't without violating the spec. Are you sure that's exactly what you want? — Enno Shioji
– Enno Shioji, Commented May 6, 2014 at 12:40
This is not a REST service. Where are the links in the json? — inf3rno
– inf3rno, Commented May 6, 2014 at 13:22
I'm not sure if this is just intended as an example, but you should never submit password information over GET, as it will get cached and inspected. — chrylis -cautiouslyoptimistic-
– chrylis -cautiouslyoptimistic-, Commented May 6, 2014 at 14:03
@Tichodromamuraria You are terribly wrong. en.wikipedia.org/wiki/HATEOAS REST should always return hypermedia, not just plain data. — inf3rno
– inf3rno, Commented May 6, 2014 at 14:06

user1907906 · Accepted Answer · 2014-05-06 14:00:51Z

If you really want to wrap a Tourist into another object, you can do this.

Tourist.java:

package entities;

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class Tourist {

    int touristId;
    String email;
    String fname;
    String lname;

TouristWrapper.java:

package entities;

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class TouristWrapper {

    Tourist tourist;

SOResource.java:

package rest;

import entities.Tourist;
import entities.TouristWrapper;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;

@Path("/so")
public class SOResource {

    @GET
    @Path("/tourists/{id}")
    @Produces("application/json")
    public TouristWrapper loginUser(@PathParam("id") int id) {
        Tourist tourist = new Tourist(id, "[email protected]", "John", "Doe");
        TouristWrapper touristWrapper = new TouristWrapper(tourist);
        return touristWrapper;
    }
}

I have simplified your usecase but you get the point: No Tourist is returned but a TouristWrapper. The JSON returned is this:

{
    "tourist": {
        "email": "[email protected]",
        "fname": "John",
        "lname": "Doe",
        "touristId": 1
    }
}

Collectives™ on Stack Overflow

REST Web service JSON format

1 Answer 1

Comments

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Related