I need make my method capable of accepting JSON data. Say I need to make a GET REST method call with JSON data.
GET /player/login/ HTTP/1.0
Content-Type: application/json
Request Body
{
"username": ”xyz”,
"password": "234fsf34"
}
I am not getting how to take this JSON data within my REST API method.
@GET
@Path("player/login")
@Produces("application/json)
public responseData loginPlayer(){
}
If you want to use authentication with a GET, the 'proper' way to do it is to use basic access authentication.
http://en.wikipedia.org/wiki/Basic_access_authentication
The client takes the username and password and forms a string of the form user:password. So in your example, that will be:
"xyz:234fsf34"
The client then base64 encodes this string. If the client is also Java, you could use the apache commons Base64 class for encoding/decoding:
http://commons.apache.org/codec/apidocs/org/apache/commons/codec/binary/Base64.html
So you get something like:
"eHl6OjIzNGZzZjM0"
And the client sends this in the GET, but as an HTTP Header (not Request Body):
GET /player/login/ HTTP/1.0
Content-Type: application/json
Authorization: Basic eHl6OjIzNGZzZjM0
The server reads this in the HTTP Header 'Authorization' much like the example code here: https://cwiki.apache.org/WINK/jax-rs-http-headers.html
Then decodes it with the (Base64 apache commons class).
Then you can respond to the GET with appropriate data.
From the syntax, it appears you are using JAX-RS.
You need to use the @Consumes annotation.
The documentation is for @Consumes is at:
http://docs.oracle.com/javaee/6/tutorial/doc/gilik.html#gipyt
A rather detailed tutorial (which uses Jersey, the reference JAX-RS implementation) is here: http://blogs.oracle.com/enterprisetechtips/entry/configuring_json_for_restful_web
Eventually, your method should be defined to accept the deserialized java object corresponding to the JSON body received from the client, and you need to set up things so that this deserialization is done before your method gets invoked. Read the second link for how to do it.
On a side note: GET methods typically do not have a 'Request Body'. It is kind of weird to have that. The POST method is meant for posting request bodies. While the HTTP standard does not explicitly disallow GET requests to have a body, POST is the appropriate choice.
@POST method can have an @Consumes and an @Produces annotation.