This tutorial is for the beginners who are new to Spring RestFull web services
The Development Of Spring restfull web services are as follows -
Step 1-
Make a project directory as show in figure with Selecting new project
Step 2- Add jars show in figure , Here jaxb-api-2.2.3.jar ,jackson-all-1.6.1.jar, commons-logging-1.1.jar and jars for spring -3
Step-3 :
Make dispatcher-servlet.xml as show below code
****************************start*************************************************
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:util="http://www.springframework.org/schema/util"
xmlns:p="http://www.springframework.org/schema/p"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:dwr="http://www.directwebremoting.org/schema/spring-dwr"
xmlns:lang="http://www.springframework.org/schema/lang"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://cxf.apache.org/configuration/beans http://cxf.apache.org/schemas/configuration/cxf-beans.xsd
http://www.springframework.org/schema/lang http://www.springframework.org/schema/lang/spring-lang-3.0.xsd
http://www.directwebremoting.org/schema/spring-dwr http://www.directwebremoting.org/schema/spring-dwr-3.0.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.1.xsd
http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.1.xsd
http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.0.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd">
<!-- Annotation Based MVC Config Setup-->
<mvc:annotation-driven />
<context:annotation-config />
<context:component-scan base-package="com.webservice.controller.**" />
<!-- View Resolver Support For JSON & JSP at one place :-) -->
<bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
<property name="mediaTypes">
<map>
<entry key="html" value="text/html"/>
<entry key="json" value="application/json"/>
</map>
</property>
<property name="viewResolvers">
<list>
<bean class="org.springframework.web.servlet.view.UrlBasedViewResolver">
<property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
<property name="prefix" value="/WEB-INF/pages/"/>
<property name="suffix" value=".jsp"/>
</bean>
</list>
</property>
<property name="defaultViews">
<list>
<bean class="org.springframework.web.servlet.view.json.MappingJacksonJsonView">
<property name="prefixJson" value="true"/>
</bean>
</list>
</property>
<property name="order" value="2" />
</bean>
</beans>
*********************************end*****************************************
Step 4-
Enter url for both .json as well as .htm entries in web.xml
*********************************start****************************************
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
<display-name>SpringWebServiceDemo</display-name>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<welcome-file-list>
<welcome-file>home.jsp</welcome-file>
</welcome-file-list>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/app-config.xml </param-value>
</context-param>
<servlet>
<servlet-name>dispatcher</servlet-name>
<servlet-class>
org.springframework.web.servlet.DispatcherServlet
</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcher</servlet-name>
<url-pattern>*.htm</url-pattern>
<url-pattern>*.json</url-pattern>
</servlet-mapping>
</web-app>
***********************end***************************************************
step 5--
Write controller for your web service
****************************start **********************************************
package com.webservice.controller;
import java.util.Date;
import java.util.Map;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
@RequestMapping("/my/neww")
public class MyfirstController {
@RequestMapping(value = "/my-new-service.json", method = RequestMethod.GET)
public @ResponseBody
Map<String, Object> topReadBook(Map<String, Object> modelMap, @RequestParam(value = "tenantId", required = false) Integer tenantId,
@RequestParam(value = "pageNo", required = false) Integer pageNo, @RequestParam(value = "recordsPerPage", required = false) Integer recordsPerPage,
@RequestParam(value = "schoolId", required = false) Integer schoolId,
@RequestParam(value = "fromDate", required = false) @DateTimeFormat(pattern = "MMM-dd-yyyy") Date fromDate,
@RequestParam(value = "toDate", required = false) @DateTimeFormat(pattern = "MMM-dd-yyyy") Date toDate) {
String name="hi you have made new service !!!";
modelMap.put("data",name );
return modelMap;
}
}
***********************************end*************************************
default jsp i.e home.jsp
********************************start****************************************
<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
pageEncoding="ISO-8859-1"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Welcome to Spring web service</title>
</head>
<body>
<h1>Welcome to Spring web service</h1>
</body>
</html>
*********************************end*****************************************
run and see the results
Thanks and enjoy, the joy of coding
