Json based Restful web service with Jersey and Jackson.
In this page you will see support for Json using Jersey and Jackson APIs. Jackson is is a multi-purpose Java library for
processing JSON data format. Jackson aims to be the best possible combination of fast, correct, lightweight, and ergonomic for
developers In this example we will convert Order object to json format.
Here is the pom.xml file. You need jersey-json jar file.
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>RestfulWebServices</groupId>
<artifactId>RestfulWebServices</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>war</packaging>
<dependencies>
<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-server</artifactId>
<version>1.17</version>
</dependency>
<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-servlet</artifactId>
<version>1.17</version>
</dependency>
<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-json</artifactId>
<version>1.17</version>
</dependency>
</dependencies>
</project>
|
Web.xml file for your reference. In web.xml add “com.sun.jersey.api.json.POJOMappingFeature” as “init-param” which supports
Json object mapping.
<web-app id="WebApp_ID" version="2.4"
xmlns="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
<servlet>
<servlet-name>jersey-serlvet</servlet-name>
<servlet-class>
com.sun.jersey.spi.container.servlet.ServletContainer
</servlet-class>
<init-param>
<param-name>jersey.config.server.provider.packages</param-name>
<param-value>com.java2novice.restful</param-value>
</init-param>
<init-param>
<param-name>com.sun.jersey.api.json.POJOMappingFeature</param-name>
<param-value>true</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>jersey-serlvet</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>
|
Our model class Order is annotated with required jackson annoations to support json transformation:
package com.java2novice.model;
import org.codehaus.jackson.annotate.JsonProperty;
public class Order {
@JsonProperty("order-no")
private int orderNo;
@JsonProperty
private String custmer;
private String address;
@JsonProperty("bill-amount")
private String amount;
public int getOrderNo() {
return orderNo;
}
public void setOrderNo(int orderNo) {
this.orderNo = orderNo;
}
public String getCustmer() {
return custmer;
}
public void setCustmer(String custmer) {
this.custmer = custmer;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
public String getAmount() {
return amount;
}
public void setAmount(String amount) {
this.amount = amount;
}
}
|
Remember that our restful web service API returning json, so annotate your
service method with @Produces and specify MIME type as application/jon.
package com.java2novice.restful;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import com.java2novice.model.Order;
@Path("/order-inventory")
public class OrderInventoryService {
@GET
@Path("/order/{orderId}")
@Produces(MediaType.APPLICATION_JSON)
public Order getUserById(@PathParam("orderId") Integer orderId){
Order ord = new Order();
ord.setOrderNo(orderId);
ord.setCustmer("Java2Novice");
ord.setAddress("Bangalore");
ord.setAmount("$2000");
return ord;
}
}
|
Try below URL to get xml output:
http://localhost:8080/RestfulWebServices/order-inventory/order/1016
|
