InfoQ

News

WADL REST API description language getting some attention

Posted by Geoffrey Wiseman on Mar 19, 2007 03:13 PM

Community
SOA
Topics
REST,
Web Services
Tags
WSDL,
WADL
To define and describe a web-service API, many developers would use WSDL. Although WSDL is meant to be extensible to any protocol and message format, most people use it for HTTP GET/POST and SOAP, when writing to WS-* standards.  On the other hand, developers writing a REST API using XML over HTTP typically don't use WSDL, or any other standardized definition/description of the API.  There will usually be some kind of human-readable documentation, but that's as far as it goes.

Not everyone is convinced that we need to describe and define REST-ful APIs, but there are those who believe it's useful.  Tim Bray suggests that it's what we need to allow users to consume an XML/HTTP API in a few lines of code.  It's certainly true that machine-readable descriptions of web APIs can allow the generation of a language-specific library.

For those who would like to describe their XML over HTTP service, a lot of options have been discussed, from SMEX-D (proposed by Tim Bray) to NSDL, and a host of alternatives. However, most of those proposals were made in 2005 or earlier, and since then none has really seen much adoption.

Marc Hadley (one of the Spec Leads for JSR-311, a Java API for RESTful services) back in 2005 proposed  WADL, the Web Application Description Language.

Since then, a number of people have been building tools to support WADL. Yahoo architect  Mark Nottingham is maintaining a stylesheet to generate documentation from WADL.

Last week, Google's Thomas Steiner unveiled that he is working on a Google project for generating language specific client libraries from WADL and generating WADL from documentation examples, tentatively called Google REST Compile and Google REST Describe.  Thomas chose WADL as the description language to be used with the new tool, after examining all the alternatives

The Sun Developer Web Pack was also released last week and contains prebuilt binaries of some WADL tools developed by Marc Hadley.

With architects at Yahoo, Google, and Sun choosing WADL for their REST tooling, perhaps WADL will receive more adoption. For more information on WADL, the reasons behind it and the alternatives, Marc Hadly's presentation (PDF, Google's HTML translation) is a good overview. 

50 comments

Reply

  1. Back to top

    WSDL

    Nov 24, 2007 9:51 PM by Nikolai Ivanov

    Many companies use XML and HTTP with no WSDL. Why bother? Thanks. http://www.1qcc.com

  2. Back to top

    Re: WSDL

    Nov 26, 2007 12:51 PM by Guest

    An early success for use of XML within BT was in the exposure of existing mainframe services using SOAP/XML messages described in WSDL. These existing services typically consist of structured text messages which could be exchanged over a variety of transports including raw TCP/IP sockets, JMS and IBM MQSeries, however most systems accessed these services via a mid-tier using a client/server technology such as DCE and later CORBA.Business-Internet

  3. Back to top

    I would stay with WSDL

    Nov 27, 2007 6:17 PM by Frank Thompson

    I understand the benefits of defining a standard, but it does not always mean that a standard will become widely adopted, instead, some de-facto standards can be very popular and widely accepted and implemented, for example, TCP/IP. Our goji berries website uses XML over HTTP without WSDL, as it is simple to declare the services, and is simple for users to call the services.

  4. Back to top

    Re: WADL usage and associated benefits

    Dec 2, 2007 10:35 AM by Don Holloway

    Andrew, thanks for the quick note. I've been working on a project to add some more utility to the concert and festival listings at http://www.websortings.com. Basic webpage listings for festivals aren't very good by themselves without date and location data for the actual event. I had done some research, and found some graduate research http://ils.unc.edu/MSpapers/2830.pdf done by Michael Graves at the University of North Carolina. He did a good job of defining the data schema, etc. But was recommending using RDF/XML. He recommended an ontology called OWL to define the event. I was fine with the data, sources, etc. but kind of got confused at the OWL layer. I do want the concert and event data to be available and accessible to outside applications, so it looks like WADL will provide a much simpler way to make sure that the data is structured properly. I read through the Sun power point presentation and it seems pretty straightforward. If it continues to be supported by Google, Sun, et all, it should be a pretty safe choice. Don

  5. Back to top

    Interesting overview of WADL

    Dec 6, 2007 3:31 PM by frank taylor

    Interesting overview of WADL. I've never heard of this language before. Looks like it's about to become more popular. Weight Loss Diet | Best Online Dating Service

  6. Back to top

    Re: WADL usage and associated benefits

    Dec 15, 2007 9:29 AM by mike gracia

    I found this post very interesting... I have used WADL for http get and http post... I think I willneed to re-read this a few times really! Ethical

  7. Back to top

    Re: WADL usage and associated benefits

    Dec 15, 2007 11:26 AM by Lukas Hanifan

    Since Yahoo, Google and Sun are implementing WADL, I think other large tech companies will follow as well. For more information on technology you can review Technology Stock News and other innovative sources for up and coming enhancements to our society. If you speak another language and need help in graspng another one quickly to learn and understand tech manuals or applications try these study abroad courses and language courses within the USA. The results can only broaden your talent with people and potential employers. I have heard a lot of news of other countires delpoying tehnology more advanced than ours earlier !! So, there is real opportunity.

  8. Back to top

    Re: WADL usage and associated benefits

    Dec 16, 2007 2:53 AM by Max Holiday Rentals

    I totally agree that it produces a more streamlined development process, and use its benefits on a daily basis. The holiday letting industry uses this software extensively and we use it on our site to help advertise Ski chalets in Europe. The superior coding qualities help sites build advertising networks quickly. This is of paramount importance in the industry of holiday home advertising. I thank you for your clear, concise information.

  9. Back to top

    Re: WADL usage and associated benefits

    Dec 27, 2007 1:46 AM by küresel ısınma

  10. Back to top

    Re: WADL usage and associated benefits

    Jan 12, 2008 7:20 AM by Bob Jackson

    I don't see any point in this at all. Some normal readable documentation should be just fine. I do not believe we need to go to such lengths to describe REST API's Clenbuterol Weight Loss

  11. Back to top

    WADL

    Jan 15, 2008 12:57 PM by Richard Wong

    i think AJAX is better or SOAP in conjuntion with equipal that become in tradicional estaquita. tranzado, pirograbado, also butaca, comedor tradicional artesanal in equipal mexico John

  12. Back to top

    Language

    Jan 17, 2008 5:12 AM by Salim Sanin

    Thanks for article http://pars-narkoteror.org http://kurtlarvadisi-pusu.com http://www.zapingtv.com http://www.gazi-dizisi.com

  13. Back to top

    thanks

    Jan 23, 2008 2:04 PM by murat tas

    thanks for this article h4ckinger warez hackhaber kankz

  14. Back to top

    very thanks

    Jan 23, 2008 2:31 PM by murat tas

    With the architects at Google and Yahoo taking a closer look, this will be receiving some much needed attention. Thanks for sharing the article,i will try it h4ckinger warez hackhaber kankz

  15. Back to top

    for article

    Jan 28, 2008 3:47 PM by alex baba

    With the architects at Google, Sun, and Yahoo taking a closer look, this will be receiving some much needed attention. At our site, we have also been using it for our XML over http. http://www.forumex.net http://www.cep-x.com

  16. Back to top

    thanks

    Jan 30, 2008 8:27 AM by mst gngr

    I found this post very interesting... I have used WADL for http get and http post... I think I willneed to re-read this a few times really! link dizini

  17. Back to top

    implemention of WADL

    Jan 30, 2008 9:36 AM by Jon chritz

    Our small firm tried to implement it by ourself with no success. we had to hire and outside consultant. We want more hand on manual and sample project outline.

  18. Back to top

    implemention of WADL

    Jan 30, 2008 9:41 AM by Jon chritz

    Our small firm tried to implement it by ourself with no success. we had to hire and outside consultant. We want more hand on manual and sample project outline. http://www.haitianite.com/main/

  19. Back to top

    Thanks

    Jan 31, 2008 5:45 PM by ruud yaman

    Very good article, I really red it in intrest. Musmula Web Directory az Lyrics

  20. Back to top

    AloneX

    Feb 2, 2008 10:08 AM by Ibrahim Can Semiz

    http://www.pixelics.org and http://www.brjdirectory.com

  21. Back to top

    WADL

    Feb 12, 2008 11:05 AM by Hasan Muhtar

    It is interesting to learn that Yahoo and Google will be implementing it. ingilizce kursu ingilizce sozluk

  22. WSDL has some java problem. Thanks for article from: Overcoming Stress
    Depression Medication
    Mortgage Refinancing
    Mortgage Calculator


  23. Back to top

    guzel

    Feb 24, 2008 12:50 PM by youtube falan

  24. Back to top

    great information

    Feb 25, 2008 5:54 PM by admiral alican

    thanks for the content it's really useful for me study abroad movie review

  25. Back to top

    perfect

    Feb 25, 2008 6:14 PM by admiral alican

    thanks for this great site and oppurtunity to let us commenting ceviri saglik

  26. Back to top

    seocontest2008

    Feb 26, 2008 5:05 AM by seocontest2008 seocontest2008

    Hello, Thanks for this article. Can I put this article to my site? Thanks again.

  27. Back to top

    thanx

    Feb 26, 2008 5:50 AM by barkuda barkuda

  28. Back to top

    Really good ! Thanks !

    Mar 14, 2008 4:09 AM by burak sahin

  29. Back to top

    WADL to describe interaction, not services.

    Mar 23, 2008 8:12 PM by William Martinez

    I wrote a couple of blogs(A RESTFull WSDL?,WADL, REST and WSDL,WSDL 2.0 - a REST Friendly Language) about the need of a service message description for REST. One solution is actually WSDL, and WSDL 2.0 may even fit better. There I explain that WADL, to me, it not a clear way to describe a service, but it is more a detailed way to describe interaction. The level is lower than describing a web service, and thus closer to implementation than to contract description. Following this, WSDL is not replaced by WADL, but may be complemented by it. A WSDL may define the service, and a WADL generated from it to actually describe a REST implementation of the web service. William Martinez

  30. Back to top

    tema

    Apr 23, 2008 9:14 AM by izzet bagce

    tema temalar theme themes mybb smf phpbb joomla mkportal nuke ipb wordpress temaları www.temalemi.com http://www.temalemi.com

  31. Back to top

    tema

    Apr 23, 2008 9:15 AM by izzet bagce

  32. Back to top

    Re: tema

    Apr 23, 2008 9:16 AM by izzet bagce

  33. Back to top

    Re: tema

    Apr 25, 2008 4:45 PM by emir karşıyakalı

  34. Back to top

    Xml over http

    May 4, 2008 10:17 AM by bosch vlademir

    At our site, we have also been using it for our XML over http. iyinet webmaster forumu 2008 seo yarışması

  35. Back to top

    BöLüm KuraLLarı!

    May 21, 2008 3:15 PM by kartal kartal

  36. Veryinformative paragraph. Thanks from
    las vegas hotels
    web hosting provider

  37. Back to top

    Thanx

    Jun 21, 2008 9:39 AM by hakan can

    An early success for use of XML within BT was in the exposure of existing mainframe services using SOAP/XML messages described Msnin WSDL. These existing services typically consist of structured text

  38. Back to top

    Thanks...

    Jul 6, 2008 6:28 AM by emre sessiz

    An early success for use of XML within BT was in the exposure of existing mainframe services using SOAP/XML messages described in WSDL. These existing services typically consist of structured text messages which could be exchanged over a variety of transports including raw TCP/IP sockets, JMS and IBM MQSeries, however most systems accessed these services via a mid-tier using a client/server technology such as DCE and later CORBA Nedir, Kimdir, Resimleri

  39. Back to top

    video seyret

    Jul 9, 2008 4:25 PM by video seyret

    thank you my friend. video seyret Herşey watch video

  40. Back to top

    Great Post

    Jul 11, 2008 6:29 PM by can enis

    Thank you for article. Bedük

  41. Back to top

    Thanks

    Jul 19, 2008 9:26 PM by kev se

  42. Back to top

    thanks

    Jul 27, 2008 11:07 AM by yasın camık

  43. Back to top

    yes thanks

    Jul 29, 2008 1:21 PM by lusi mayk

    The big news is a commitment from all the parties to not patent any of them, nor let sohbet oyun indir program facebook chatanyone try to appropriate the IP and patent it without OpenID's consent.

  44. Back to top

    kucuk kadinlar basladi

    Jul 29, 2008 1:27 PM by lusi mayk

    The big news is a commitment from all the parties to not patent any of them, nor let sohbet oyun indir program facebook chatanyone try to appropriate the IP and patent it without OpenID's consent.

  45. Back to top

    Thanks...

    Aug 4, 2008 2:12 AM by guzelresim 123

    An early success for use of XML within BT was in the exposure of existing mainframe services using SOAP/XML messages described in WSDL. These existing services typically consist of structured text messages which could be exchanged over a variety of transports including raw TCP/IP sockets, JMS and IBM MQSeries, however most systems accessed these services via a mid-tier using a client/server technology such as DCE and later CORBA Msn nickleri

  46. Back to top

    oke

    Aug 13, 2008 5:33 PM by yasın camık

  47. Back to top

    Language

    Aug 23, 2008 2:34 PM by mehmet andpaur

  48. Back to top

    Good luck guys

    Aug 23, 2008 3:10 PM by mehmet andpaur

  49. Back to top

    Thanks

    Aug 30, 2008 2:00 AM by Cagatay Uskudar

  50. Back to top

    kuycuklr

    Aug 30, 2008 6:23 AM by lusi mayk

    The big news is a commitment from all the parties to not patent any of them, nor let bedava sohbet oyun indir program indir oyun indir chatanyone try to appropriate the IP and patent it without OpenID's consent

Exclusive Content

Agile in Practice: What Is Actually Going On Out There?

Scott Ambler talks about actual data resulting from surveys made during 2006-2008, showing how Agile is perceived and implemented within organizations.

Building Smart Windows Applications

From QCon 2008, Daniel Moth presents on using Visual Studio 2008 and .NET 3.5 to create compelling rich Windows applications.

Joshua Kerievsky about Industrial XP

Joshua Kerievsky, founder of Industrial Logic, talks about Industrial Extreme Programming which extends XP by including practices dealing with management, customers and developers.

Jeff Barr Discusses Amazon Web Services

Amazon Web Services (AWS) Evangelist Jeff Barr discusses SimpleDB, S3, EC2, SQS, cloud computing, how different Amazon services interact, origins of AWS, AWS globalization and the March AWS outage.

More Than Just Spin (Up) : Virtualization for the Enterprise and SaaS

Cloud services have helped bring virtualization to the forefront. Its full power however, also includes other benefits such as high availability, disaster recovery, and rapid provisioning.

Ruby Beyond Rails

John Lam talks about his path to dynamic languages, some of the problems of making IronRuby run fast, and how the DLR helps with implementing languages.

VMware Infrastructure 3 Book Excerpt and Author Interview

VMware Infrastructure 3: Advanced Technical Design Guide and Advanced Operations Guide provides a wealth of practical insights into setting up virtualization in todays corporate environments.

Architectures of extraordinarily large, self-sustaining systems

Can a system that is so large it cannot be comprehended be "designed" in a conventional sense? The foundations of computing are about to change. In this talk, Richard P. Gabriel explores why and how.