• Table of contents
• RESTful Web Services
  • System Overview
  • Programming Guide
    • How to add new web service method
    • How to develop web service client

RESTful Web Services¶

System Overview
¶

Programming Guide¶

Below is the overview of the web service layers:

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 JSON formatted data
• (5) all of the components share the same domain objects

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 source file can be found in the trunk, connector-poc in SCM

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):

Detailed Description:

• 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

How to develop web service client¶

Any programming language which has the RESTful & JSON API. For the sample RESTful client, refer to the com.ecosway.connector.poc.client package in the connector-poc project in the SCM.