Project

General

Profile

RESTful Web Services » History » Revision 11

Revision 10 (chin-yeh, 10/12/2011 06:18 PM) → Revision 11/14 (chin-yeh, 10/12/2011 06:20 PM)

{{toc}} 

 h1. RESTful Web Services 

 h2. System Overview 
 !rest_json.png! 

 h2. Programming Guide 

 Below is the overview of the *web service layers*: 
 !component.png! 
 _Detailed Description:_ 
 * *(1)* this is the only integration point for the client 
 * *(2)* this is the service layer that contains business logic 
 * *(3)* this is the persistence layer 
 * *(4)* this is the web service client, it could be web application, ajax application, batch program, as long as it can read or parse <code>JSON</code> formatted data 
 * *(5)* all of the components share the same domain objects 

 h3. How to add new web service method 

 We use the *Shopper* service to demonstrate how to add new web service method into the existing web service. 

 The *Shopper* service provides: 
 * add new shopper 
 * update shopper profile 
 * retrieve shopper profile based on ID 

 In short, a new web service method should contain the following components(at least): 
 !mapping.png! 
 * *Controller* - this is the place where the client talk to 
 * *Services* - this is the business logic of the service 
 * *DAOs* - persist or query data from data source, e.g. database