WADL示例

1.3 WADL示例

 

下面是一个雅虎新闻搜索应用的WADL描述示例。

 

 

Xml代码  

1. <?xml version="1.0"?>  
2. <application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
3.     xsi:schemaLocation="http://research.sun.com/wadl/2006/10 wadl.xsd"  
4.     xmlns:tns="urn:yahoo:yn" xmlns:xsd="http://www.w3.org/2001/XMLSchema"  
5.     xmlns:yn="urn:yahoo:yn" xmlns:ya="urn:yahoo:api" xmlns="http://research.sun.com/wadl/2006/10">  
6.     <grammars>  
7.         <include href="NewsSearchResponse.xsd" />  
8.         <include href="Error.xsd" />  
9.     </grammars>  
10.   
11.     <resources base="http://api.search.yahoo.com/NewsSearchService/V1/">  
12.         <resource path="newsSearch">  
13.             <method name="GET" id="search">  
14.                 <request>  
15.                     <param name="appid" type="xsd:string" style="query" required="true" />  
16.                     <param name="query" type="xsd:string" style="query" required="true" />  
17.                     <param name="type" style="query" default="all">  
18.                         <option value="all" />  
19.                         <option value="any" />  
20.                         <option value="phrase" />  
21.                     </param>  
22.                     <param name="results" style="query" type="xsd:int" default="10" />  
23.                     <param name="start" style="query" type="xsd:int" default="1" />  
24.                     <param name="sort" style="query" default="rank">  
25.                         <option value="rank" />  
26.                         <option value="date" />  
27.                     </param>  
28.                     <param name="language" style="query" type="xsd:string" />  
29.                 </request>  
30.                 <response>  
31.                     <representation mediaType="application/xml" element="yn:ResultSet" />  
32.                     <fault status="400" mediaType="application/xml" element="ya:Error" />  
33.                 </response>  
34.             </method>  
35.         </resource>  
36.     </resources>  
37. </application>  

<?xml version="1.0"?>
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://research.sun.com/wadl/2006/10 wadl.xsd"
	xmlns:tns="urn:yahoo:yn" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
	xmlns:yn="urn:yahoo:yn" xmlns:ya="urn:yahoo:api" xmlns="http://research.sun.com/wadl/2006/10">
	<grammars>
		<include href="NewsSearchResponse.xsd" />
		<include href="Error.xsd" />
	</grammars>

	<resources base="http://api.search.yahoo.com/NewsSearchService/V1/">
		<resource path="newsSearch">
			<method name="GET" id="search">
				<request>
					<param name="appid" type="xsd:string" style="query" required="true" />
					<param name="query" type="xsd:string" style="query" required="true" />
					<param name="type" style="query" default="all">
						<option value="all" />
						<option value="any" />
						<option value="phrase" />
					</param>
					<param name="results" style="query" type="xsd:int" default="10" />
					<param name="start" style="query" type="xsd:int" default="1" />
					<param name="sort" style="query" default="rank">
						<option value="rank" />
						<option value="date" />
					</param>
					<param name="language" style="query" type="xsd:string" />
				</request>
				<response>
					<representation mediaType="application/xml" element="yn:ResultSet" />
					<fault status="400" mediaType="application/xml" element="ya:Error" />
				</response>
			</method>
		</resource>
	</resources>
</application>

 

 

第2—8行开始一个应用的描述，定义在应用描述的其他地方要用到的XML命名空间。

第2—9行定义了服务要用到的XML语法（grammars），这里包含了两个XMLSchema文件

的引用。

第16—45行描述了雅虎新闻搜索的Web资源和这个资源支持的HTTP方法。

第18—43行描述了 "search" GET方法，

第19—36行描述了 方法的输入，

第37—42行描述了 方法可能的输入，