Link Details

Link 750577 thumbnail
User 121174 avatar

By jd44165
via smartjava.org
Published: Feb 24 2012 / 12:05

Some people believe that REST services are fully self-documenting. Although this is true to a degree, not everything is self-explanatory. In this article I show a couple of pointers and elements that you should take into consideration when creating and documenting REST based APIs and services.
  • 6
  • 0
  • 725
  • 646

Comments

Add your comment
User 226303 avatar

devdanke replied ago:

0 votes Vote down Vote up Reply

Great question! They certainly need documentation. A nice simple convension for documenting REST services would be useful to many developers. [I agree, WADL is too formal and cumbersome (to much like the horrific WSDL).]

Two of the more popular public REST APIs are from Google and Amazon. They're document and they're documented differently.

There's a good chance someone will invent a nice simple way to document REST APIs, but only if IBM, Microsoft, and Oracle can be kept out of it. These companies (and their complexity loving engineers) create the worst, most impractical, and painful standards (e.g. D/COM, SOAP, and EJB).

Add your comment


Html tags not supported. Reply is editable for 5 minutes. Use [code lang="java|ruby|sql|css|xml"][/code] to post code snippets.

Voters For This Link (6)



Voters Against This Link (0)



    Java Performance Optimization
    Written by: Pierre-Hugues Charbonneau
    Featured Refcardz: Top Refcardz:
    1. Design Patterns
    2. OO JS
    3. Cont. Delivery
    4. Java EE7
    5. HTML5 Mobile
    1. Node.js
    2. Debugging JavaScript
    3. OO JS
    4. JSON
    5. Ajax