imported>Suriname0: Adding local short description: "Structured language for Web services", overriding Wikidata description "structured language used to describe Web applications"

2025-03-27T16:22:53Z

Adding local short description: "Structured language for Web services", overriding Wikidata description "structured language used to describe Web applications"

New page

{{Short description|Structured language for Web services}}
The '''Web Application Description Language''' ('''WADL''') is a machine-readable [[XML]] description of [[Hypertext Transfer Protocol|HTTP]]-based [[web service]]s.{{r|submission}} WADL models the resources provided by a service and the relationships between them.{{r|submission}} WADL is intended to simplify the reuse of web services that are based on the existing HTTP architecture of the Web.{{r|submission|teamcomment}} It is platform and language independent and aims to promote reuse of applications beyond the basic use in a web browser.{{r|submission}}
WADL was submitted to the [[World Wide Web Consortium]] by [[Sun Microsystems]] on 31 August 2009{{r|submission}}, but the consortium has no current plans to standardize it{{r|teamcomment}}. WADL is the [[REST]] equivalent of [[SOAP]]'s [[Web Services Description Language]]s (WSDL), which can also be used to describe [[REST]] web services.{{r|ibm_wsdl2}}

==Format==
The service is described using a set of ''[[web resource|resource]]'' elements. Each resource contains ''param'' elements to describe the inputs, and ''method'' elements which describe the ''request'' and ''response'' of a resource. The ''request'' element specifies how to represent the input, what types are required and any specific HTTP headers that are required. The ''response'' describes the representation of the service's response, as well as any fault information, to deal with errors.

==Example==
The following listing shows an example of a WADL description for the Yahoo News Search application.
<syntaxhighlight lang="xml">
<application xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://wadl.dev.java.net/2009/02 wadl.xsd"
xmlns:tns="urn:yahoo:yn" xmlns:yn="urn:yahoo:yn" xmlns:ya="urn:yahoo:api"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://wadl.dev.java.net/2009/02">
<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 status="200">
<representation mediaType="application/xml" element="yn:ResultSet"/>
</response>
<response status="400">
<representation mediaType="application/xml" element="ya:Error"/>
</response>
</method>
</resource>
</resources>
</application>
</syntaxhighlight>

==Generate WADL or generate code from WADL==
===Java===
There are multiple tools to generate java code from an existing WADL:<ref>[https://javaee.github.io/wadl/ github WADL project]</ref><ref>[http://cxf.apache.org Apache CXF]</ref>
*[[Apache CXF]]
*[[Java API for RESTful Web Services]], and its reference implementation, Jersey

===Example WADL Generated by CXF===
<syntaxhighlight lang="xml">
<app xmlns="http://research.sun.com/wadl/2006/10" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<grammars>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="unqualified"
elementFormDefault="unqualified">
<xs:element name="appProfile" type="appProfile"/>
<xs:element name="customerProfile" type="customerProfile"/>
<xs:complexType name="customerProfile">
<xs:sequence>
<xs:element minOccurs="0" name="accessPaymentServicesEnabled" type="xs:boolean"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="attributes" nillable="true" type="attribute"/>
<xs:element minOccurs="0" name="billingType" type="xs:string"/>
<xs:element minOccurs="0" name="defaultCurrency" type="xs:string"/>
<xs:element minOccurs="0" name="defaultSpendingLimitCurrency" type="xs:string"/>
<xs:element minOccurs="0" name="maximumSpendingLimit" type="xs:double"/>
<xs:element minOccurs="0" name="minimumSpendingLimit" type="xs:double"/>
<xs:element minOccurs="0" name="customerCategory" type="xs:string"/>
<xs:element minOccurs="0" name="customerEnabled" type="xs:boolean"/>
<xs:element minOccurs="0" name="customerName" type="xs:string"/>
<xs:element minOccurs="0" name="paymentNotificationEndpointAddress" type="xs:string"/>
<xs:element minOccurs="0" name="pseCustomerId" type="xs:string"/>
<xs:element minOccurs="0" name="resourceURL" type="xs:string"/>
<xs:element minOccurs="0" name="settlementContractUuid" type="xs:string"/>
<xs:element minOccurs="0" name="isSpendingLimitEnabled" type="xs:boolean"/>
<xs:element minOccurs="0" name="abcCustomerId" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="attribute">
<xs:sequence>
<xs:element minOccurs="0" name="key" type="xs:string"/>
<xs:element minOccurs="0" name="value" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="appProfile">
<xs:sequence>
<xs:element minOccurs="0" name="appEnabled" type="xs:boolean"/>
<xs:element minOccurs="0" name="appName" type="xs:string"/>
<xs:element minOccurs="0" name="appPassword" type="xs:string"/>
<xs:element minOccurs="0" name="appUserName" type="xs:string"/>
<xs:element minOccurs="0" name="appUuid" type="xs:string"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="attributes" nillable="true" type="attribute"/>
<xs:element minOccurs="0" name="description" type="xs:string"/>
<xs:element minOccurs="0" name="customerName" type="xs:string"/>
<xs:element minOccurs="0" name="resourceURL" type="xs:string"/>
<xs:element minOccurs="0" name="serviceContractName" type="xs:string"/>
<xs:element minOccurs="0" name="abcAppId" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
</grammars>
<resources base="http://mpsamara-mobl-vm1:9078/customermanagement/v1">
<resource path="/customers">
<resource path="/">
<method name="DELETE">
<request></request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
<method name="GET">
<request>
<param name="page" style="query" type="xs:int"/>
<param name="partialCustomerName" style="query" type="xs:string"/>
</request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
<method name="POST">
<request>
<representation mediaType="app/json"/>
</request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
<method name="PUT">
<request></request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
</resource>
<resource path="/{customerUserName}">
<method name="DELETE">
<request></request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
</resource>
<resource path="/{customerUserName}">
<param name="customerUserName" style="template" type="xs:string"/>
<method name="GET">
<request></request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
<method name="POST">
<request>
<representation mediaType="app/json"/>
</request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
</resource>
<resource path="/{customerUserName}">
<method name="PUT">
<request></request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
</resource>
<resource path="/{customerUserName}/apps">
<method name="DELETE">
<request></request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
</resource>
<resource path="/{customerUserName}/apps">
<param name="customerUserName" style="template" type="xs:string"/>
<method name="GET">
<request>
<param name="page" style="query" type="xs:int"/>
</request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
<method name="POST">
<request>
<representation mediaType="app/json"/>
</request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
</resource>
<resource path="/{customerUserName}/apps">
<method name="PUT">
<request></request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
</resource>
<resource path="/{customerUserName}/apps/{appName}">
<method name="DELETE">
<request></request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
</resource>
<resource path="/{customerUserName}/apps/{appName}">
<param name="customerUserName" style="template" type="xs:string"/>
<param name="appName" style="template" type="xs:string"/>
<method name="GET">
<request></request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
<method name="POST">
<request>
<representation mediaType="app/json"/>
</request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
</resource>
<resource path="/{customerUserName}/apps/{appName}">
<method name="PUT">
<request></request>
<response>
<representation mediaType="app/json"/>
</response>
</method>
</resource>
</resource>
</resources>
</app>
</syntaxhighlight>

== See also ==
* [[Overview of RESTful API Description Languages]]
* [[OpenAPI Specification]] (Swagger)
* [[RAML (software)]]

==References==
{{Reflist|refs=

<ref name="submission">
{{cite web
|title = Web Application Description Language: W3C Member Submission 31 August 2009
|author = Sun Microsystems
|author-link = Sun Microsystems
|date = 31 August 2009
|publisher = [[World Wide Web Consortium]]
|accessdate = 12 August 2012
|url = http://www.w3.org/Submission/wadl/
}}
</ref>

<ref name="teamcomment">
{{cite web
|title = Team Comment on the "Web Application Description Language" Submission
|author = World Wide Web Consortium
|author-link = World Wide Web Consortium
|date = 14 October 2009
|publisher = [[World Wide Web Consortium]]
|accessdate = 12 August 2012
|url = http://www.w3.org/Submission/2009/03/Comment
}}
</ref>

<ref name="ibm_wsdl2">
{{cite web
|title = Describe REST Web services with WSDL 2.0: A how-to guide
|author = Lawrence Mandel
|date = 29 May 2008
|publisher = [[IBM]]
|accessdate = 12 August 2012
|url = http://www.ibm.com/developerworks/webservices/library/ws-restwsdl/
}}
</ref>
}}

==External links==
*[https://github.com/javaee/wadl WADL home page on github]
*[http://java.net/projects/wadl/sources/svn/content/trunk/www/wadl20090202.pdf Current specification for WADL]
*{{cite web |last1=Carlyle |first1=Benjamin |title=WADL for REST-style SOA |url=http://soundadvice.id.au/blog/2009/08/31/ |website=soundadvice.id.au |access-date=9 September 2021 |format=2009-08-31}}
[[Category:Web services]]
[[Category:XML]]

Web Application Description Language - Revision history

imported>Suriname0: Adding local short description: "Structured language for Web services", overriding Wikidata description "structured language used to describe Web applications"