JAX-RS Tutorilas: Hello World Example

Following is simple JAX-RS tutorial, which sends “Hello World” text as response string using JAX-RS API and Jersey implementation.
Technologies and Tools used in this article:

1.    JDK 
2.    Eclipse 
3.    Tomcat
4.    Maven 
5.    Jersey 1.8

Create Maven Web Project

Create a Maven web project and name it "helloworld" .
  • File -> New -> Other -> Maven Project -> Next
  • Select maven-archetype-webapp
  • Select Next
  • Type Group Id, Artifact Id and Package name
  • And select Finish

Add Project Dependencies

Add Jersey repository using Maven. Use following URL to get appropriate repository.
Now update pom.xml file.
File : pom.xml

<project ... >




Create REST Service

Now it is time to create a class which serves as REST service.
Create class named “RestService” and a public method “getMessage
package com.zain.restapi;

import javax.ws.rs.core.Response;
import javax.ws.rs.GET;
import javax.ws.rs.Path;

public class RestService {

 public Response getMessage() {

  String message = "Hello World!";

  return Response.status(200).entity(message).type("text/plain").build();


@Path annotation act as routing which map incoming URI to appropriate Class

Update web.xml for Jersey configuration

In web.xml, add servlet with class “com.sun.jersey.spi.container.servlet.ServletContainer

File : web.xml

<web-app  version="2.4"


Directory Structure

Final project directory structure


To execute this application you need to type following URL
http://localhost:8080/{project name}/{jersey servlet name}/{@path param value}
here is actual URL for this tutorial.

Source Code

Download source code from this Github link



Popular posts from this blog

Abstract Factory design pattern analysis

MongoDB Tutorials : Aggregation Framework

AngularJs Tutorial: Getting Started