Skip to main content

JAX-RS Tutorilas: Hello World Example

Image
By


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.
http://mvnrepository.com/artifact/com.sun.jersey/jersey-server
Now update pom.xml file.
File : pom.xml

<project ... >
...
        ...
<dependencies>
                ...
                ...

<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-server</artifactId>
<version>1.8</version>
</dependency>

</dependencies>
<build>
<finalName>helloworld</finalName>
</build>


</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;


@Path("/message")
public class RestService {

 @GET
 public Response getMessage() {

  String message = "Hello World!";

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

Note:

@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"
       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>com.sun.jersey.config.property.packages</param-name>
                   <param-value>com.zain.restapi</param-value>
              </init-param>
              <load-on-startup>1</load-on-startup>
       </servlet>

       <servlet-mapping>
              <servlet-name>jersey-serlvet</servlet-name>
              <url-pattern>/rest/*</url-pattern>
       </servlet-mapping>
</web-app>   

Directory Structure


Final project directory structure


 Demo


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.
http://localhost:8080/helloworld/rest/message


Source Code


Download source code from this Github link

References


Labels:

Comments

Post a Comment

Subscribe for latest tutorial updates

* indicates required

Popular posts from this blog

Preload Images Using Javascript

By
Preload Image is technique which helps browser to render images with minimum delay. Today we will see example of image gallery. Gallery contain 5 images which load images one after another whenever user clicks next and back button. This is a basic image gallery scenario which is used in all possible website, then why we need preloaded images for this gallery? Now a day’s most of website becoming faster and user expectation is increasing. Suppose your website doesn’t use preload image technique for gallery and a user visits any image gallery from Google Plus or Facebook and visits your website gallery. Then that user always prefer those websites rather than yours. Why? Because your website load one image at a time. When user click on next button, then only gallery load image and user has wait till it get loaded. To avoid this situation gallery needs to download all images ...
Post a Comment
Read more

AJAX - How To Retrieve JSON Response from PHP script

By
Hello Friends, This is my first tutorial post. Today I'll explain you how to retrieve JSON response via Ajax call. First we build a PHP script to send response in JSON format, then we will gather this response from an Ajax call through jQuery script. Let’s first create a PHP script  Create a PHP script, I’ll name it as “json_response.php” And add following code in it json_response.php <?php //set header for JSON response header("Content-Type: application/json"); //render array in JSON format echo json_encode(array('status' => 200, 'message' => 'Response from PHP script in JSON format.')); This is a basic example to send JSON response. PHP script will send response with status code and message. Now create a HTML file to fetch JSON response and add it in header tag. Create a HTML file, I’ll name it as “json_response.html” And add following code. json_response.html <html>           ...
Post a Comment
Read more

JSON Tutorials : Getting Started

By
JSON is widely accepted text formatted structured data. JSON stands for " JavaScript Object Notation ". In general JSON can represent 1. Object of database record. 2. Object to represent a list of HTML elements. 3. Result of search query. 4. Response of an Ajax call. Here you can see JSON is used in many different areas and for many different scenarios. This means it has simple data structure. most of programming languages adopt it and it can flow easily from one connection to another. You can find JSON office definition here JSON Official Site . JSON is represented by two structural types, which includes two primitive types. Structural types Array : A sequential list of primitive data types between square brackets [ ] Object : Collection of key, value pair stored inside curly braces { }, where value would be primitive data type Primitive types : There are two primitive types key and value. " key " should be string and " value (data type)...
Post a Comment
Read more