RESTful API Documentation
Posted
by
PartlyCloudy
on Stack Overflow
See other posts from Stack Overflow
or by PartlyCloudy
Published on 2009-12-27T15:52:45Z
Indexed on
2012/04/12
17:28 UTC
Read the original article
Hit count: 600
rest
|documentation
I'm going to design a RESTful API soon, thus I need to describe it in order to enable other people to start implementing clients using it.
I've looked around a bit, but unfortunately, I've not found any standardized form of describing web-based RESTful services. What I'am looking for is something like JavaDoc, although it don't have to be generated out of any sort of code. I'm also not talking about something like WADL, I rather want to have some human-readable documentation I can hand out.
Due to the nature of RESTful web-based services, it should be quite easy to standardize a documentation. It should just list available ressources, corresponding URIs, allowed methods, content-types and describe the availabe actions. Do you have any suggestions therefore?
Thanks in advance & Greets
© Stack Overflow or respective owner