What is it like to consume RESTful web services without proper IDLs (WSDLs or WADLs)?
-
At a minimum, shouldn't there be a standard way to document a web service's API, just like we use Javadoc for Java APIs? WSDLs allow tools like XMLSpy to create a service request template that QA and web service clients can use to easily consume the service and learn more about its behavior and properties. Is that not a gap in the case of RESTful web services, most of which don't use WADL?
-
Answer:
I highly recommend reading the following for a pretty decent discussion on WADL: http://bitworking.org/news/193/Do-we-need-WADL Personally, I'm not a fan of WADL. There's significant engineering overhead involved in maintaining machine readable (or generated) documentation, which makes it much more fragile (or tightly coupled) than other methods of publishing documentation. Outside of the technical realm, I've never had a customer, client, engineer, employee, investor, or prospect request a WADL document. I would much rather have my engineers focused on features that solve real problems. Update -- Puneet asked for an example of how to learn about an API that isn't programatic, but is still consistent and reliable. I think a great example is Twitter's API documentation: https://dev.twitter.com/docs/api This provides substantially more than the parameters, responses, and faults: it also provides context, philosophy, examples, and tutorials -- things you need to reference for any API. Don't get me wrong: I love standardized formats as a way to communicate information ... but SOAP and the WS-* protocols were better served by programatic descriptions, because the interactions were so complex. The modern REST approach to building APIs is a change in direction: that sophisticated systems can be built more easily without the additional complexity of SOAP and other "middle tier" protocols.
Peat Bakke at Quora Visit the source
Other answers
WADL is not active recently as I known, instead of, Swagger(http://swagger.io/) is used more and more widely. OData which pushed by Microsoft strongly, also can be used to describe REST service. Below is my understanding to OData and Swagger: The emphasis of OData and Swagger is different. Swagger aims to describe the REST resources and the operations to resource, also includes the description of data schema. OData describes REST resources, data model and data manipulation like query/search/filter/edit... But I still think they are overlapping, maybe in future, there's only one standard just like today's SOAP web service, people only use WSDL.
Wenchun Zhang
Related Q & A:
- How to create a Restful web service in .Net Using MySQL?Best solution by stackoverflow.com
- What is it like to have a web design job?Best solution by webdesign.about.com
- What are the major differences between products and services?Best solution by wiki.answers.com
- What careers could I have with a Human Services degree?Best solution by eHow old
- Is it possible to become a professional web designer without college?Best solution by Yahoo! Answers
Just Added Q & A:
- How many active mobile subscribers are there in China?Best solution by Quora
- How to find the right vacation?Best solution by bookit.com
- How To Make Your Own Primer?Best solution by thekrazycouponlady.com
- How do you get the domain & range?Best solution by ChaCha
- How do you open pop up blockers?Best solution by Yahoo! Answers
For every problem there is a solution! Proved by Solucija.
-
Got an issue and looking for advice?
-
Ask Solucija to search every corner of the Web for help.
-
Get workable solutions and helpful tips in a moment.
Just ask Solucija about an issue you face and immediately get a list of ready solutions, answers and tips from other Internet users. We always provide the most suitable and complete answer to your question at the top, along with a few good alternatives below.