Author: jonathan
Date: Mon Jan 28 03:49:04 2008
New Revision: 13060
Log:
Mostly typos
Modified:
trunk/mashup/java/xdocs/restyservices.html
trunk/mashup/java/xdocs/toc.html
Modified: trunk/mashup/java/xdocs/restyservices.html
==============================================================================
--- trunk/mashup/java/xdocs/restyservices.html (original)
+++ trunk/mashup/java/xdocs/restyservices.html Mon Jan 28 03:49:04 2008
@@ -3,7 +3,7 @@
<head>
<meta http-equiv="content-type" content="" />
- <title>Writing RESTy services</title>
+ <title>Writing RESTful services</title>
<link href="styles.css" rel="stylesheet" type="text/css" media="all" />
@@ -14,26 +14,25 @@
<body lang="EN-US">
<div id="main-content">
-<h1>Writing RESTy services</h1>
+<h1>Writing RESTful services</h1>
-<p>The Mashup Server helps you write RESTy services with relative
-ease.
-This is facilitated by the use of the httpMethod and the
-httpLocation annotations. As theres names imple the httpMethod is used
+<p>The Mashup Server helps you write RESTful services with relative
+ease, facilitated by the use of the httpMethod and the
+httpLocation annotations. As their names imply the httpMethod is used
to specify the HTTP method to be used and the httpLocation annotation
specifies how the parameters can be sent in the request URI. These two
-annotation helps you build truly RESTy mashups. You can have a look at
+annotation helps you build truly RESTful mashups. You can have a look at
the RESTSample that ships as a sample with the WSO2 Mashup Server for
-usage of these annotations.</p>
+an illustration of the usage of these annotations.</p>
<br />
-<h2 id="inputTypes">httpMethod annotation</h2>
+<h2 id="httpMethod">httpMethod annotation</h2>
<br />
-The httpMethod annotation helps you speficy the HTTP Method that the
-operation will be exposed under. Supported HTTP methods are GET, POST,
+The httpMethod annotation helps you specify the HTTP Method under which the
+operation will be exposed. Supported HTTP methods are GET, POST,
PUT and DELETE.<br />
<br />
@@ -58,12 +57,12 @@
}</p>
<br />
If the httpMethod is not specified the operation is
-exposed under a default HTTP method. The defaulting rule is as follows,<br />
+exposed with a default HTTP method. The defaulting rule is as follows,<br />
<br />
-1. If the operation is marked as safe using the {function}.safe
-annotaion the HTTP method would default to GET (the .safe annotation
+1. If the operation is marked as "safe" using the {function}.safe
+annotation the HTTP method defaults to GET (the .safe annotation
defaults to false unless explicitly set).<br />
<p class="code">defaultsToGET.safe = true;<br />
@@ -76,7 +75,7 @@
</p>
-2. If the operation is marked as not safe the HTTP method would default
+2. If the operation is not marked as safe, or marked as not safe the HTTP
method defaults
to POST.<br />
<p class="code">function defaultsToPOST() {<br />
@@ -92,33 +91,34 @@
The
httpLocation annotation helps you take control of the URI and expose
this operation under a logical URI. It does this by specifying a
-pattern
-for serializing input parameters of the function in the request
-URI. Curly braces are
-used to specify the name of a input parameter, which determines where
-the instance data of that parameter will be located
+pattern, or template,
+for serializing input parameters of the function in the request
+URI. Curly braces are
+used to specify the name of an input parameter, which determines where
+the instance data of that parameter appears
in the path component of the request URI. In the stubs the curly
-brace-enclosed name will be replaced with instance data in
+brace-enclosed name is replaced with instance data in
constructing the path component. Remaining input instance data (not
-specified by<span style="font-family: monospace;"> httpLocation
annotation</span><code></code>)
-will be serialized
+specified by<span style="font-family: monospace;"> httpLocation
annotation</span>)
+is serialized
into the query string portion of the URI. In order for the httpLocation
annotation to be effective you have to use it in conjuction with
-inputTypes annotation (The server needs to be aware of how to build the
+inputTypes annotation. The server needs to be aware of how to build the
payload from the request URI and the inputTypes annotation makes this
-possible). <br />
+possible.<br />
<br />
-The following example shows the use of httpMethod and httpLocation
annotations. You can try the service out on your local Mashup Server. Its
shipped as the RESTSample.<br />
+The following example shows the use of httpMethod and httpLocation
annotations. You can
+try the service out on your local Mashup Server. It's shipped as the
RESTSample.<br />
<br />
<p class="code">getWeather.safe = true;<br />
getWeather.httpMethod = "GET";<br />
getWeather.httpLocation = "weather/{city}";<br />
getWeather.inputTypes = "string";<br />
function getWeather(city){<br />
-var details = session.get(city);<br />
-// return whether details of city<br />
-// for e.g to get the weather details of colombo you need to perform a
-GET on http://localhost:7762/services/samples/RESTSample/weather/colombo<br />
+ var details = session.get(city);<br />
+ // return whether details of city<br />
+ // for e.g to get the weather details of colombo you need to
perform a<br />
+ // GET on
http://localhost:7762/services/samples/RESTSample/weather/colombo<br />
}<br />
<br />
POSTWeather.httpMethod = "POST";<br />
@@ -126,24 +126,23 @@
POSTWeather.inputTypes = {"city" : "string",<br />
"weatherDetails" : "string"};<br />
function POSTWeather(city, weatherDetails){<br />
-// add the weather details of city<br />
-// for e.g to add weather details of colombo you need to perform a POST
-on http://localhost:7762/services/samples/RESTSample/weather/colombo
-with the following payload<br />
-//<POSTWeather><br />
-// <city>colombo</city><br />
-// <weatherDetails>30</weatherDetails><br />
-//</POSTWeather><br />
+ // Add the weather details of city<br />
+ // For e.g to add weather details of colombo you need to perform
a POST<br />
+ // on
http://localhost:7762/services/samples/RESTSample/weather/colombo<br />
+ // with the following payload<br />
+ // <POSTWeather><br />
+ // <city>colombo</city><br />
+ //
<weatherDetails>30</weatherDetails><br />
+ //</POSTWeather><br />
}<br />
<br />
DeleteWeather.httpMethod = "DELETE";<br />
DeleteWeather.httpLocation = "weather/{city}";<br />
DeleteWeather.inputTypes = "string";<br />
function DeleteWeather(city){<br />
-// delete the weather details of city<br />
-// for e.g to delete the weather details of colombo you need to perform
-a DELETE on
-http://localhost:7762/services/samples/RESTSample/weather/colombo<br />
+ // Delete the weather details of city<br />
+ // For e.g to delete the weather details of colombo you need to
perform<br />
+ // a DELETE on
http://localhost:7762/services/samples/RESTSample/weather/colombo<br />
}<br />
<br />
PUTWeather.httpMethod = "PUT";<br />
@@ -151,20 +150,19 @@
PUTWeather.inputTypes = {"city" : "string",<br />
"weatherDetails" : "string"};<br />
function PUTWeather(city, weatherDetails){<br />
-// update the weather details of city<br />
-// for e.g to update the weather details of colombo you need to perform
-a PUT on
-http://localhost:7762/services/samples/RESTSample/weather/colombo with
-the following payload<br />
-//<PUTWeather><br />
-// <city>colombo</city><br />
-// <weatherDetails>35</weatherDetails><br />
-//</PUTWeather><br />
+ // Update the weather details of city<br />
+ // For e.g to update the weather details of colombo you need to
perform<br />
+ // a PUT on
http://localhost:7762/services/samples/RESTSample/weather/colombo with<br />
+ // the following payload<br />
+ // <PUTWeather><br />
+ // <city>colombo</city><br />
+ //
<weatherDetails>35</weatherDetails><br />
+ // </PUTWeather><br />
}</p>
</div>
-<p>© WSO2 Inc.</p>
+<p>© 2007-2008 WSO2 Inc.</p>
</body>
</html>
Modified: trunk/mashup/java/xdocs/toc.html
==============================================================================
--- trunk/mashup/java/xdocs/toc.html (original)
+++ trunk/mashup/java/xdocs/toc.html Mon Jan 28 03:49:04 2008
@@ -60,7 +60,7 @@
Data Binding</a></li>
- <li><a href="restyservices.html" target="mainFrame">Writing RESTy
services</a></li>
+ <li><a href="restyservices.html" target="mainFrame">Writing RESTful
services</a></li>
<li><a href="e4xquickstart.html" target="mainFrame">E4X
_______________________________________________
Mashup-dev mailing list
[email protected]
http://www.wso2.org/cgi-bin/mailman/listinfo/mashup-dev
