4 ms·
I wonder if there is some convention for automatic api exploration. Would be nice also for auto documentation.
by gbog 14y ago
I wonder if there is some convention for automatic api exploration. Would be nice also for auto documentation.
- lucaspiller 14y agohttp://en.wikipedia.org/wiki/Web_Services_Description_Language http://en.wikipedia.org/wiki/Web_Services_Description_Langua... ?
- untothebreach 14y agoWSDLs appear to be permanently associated with SOAP, so I don't see them gaining much traction with the REST crowd.
- hunvreus 14y agoThere are ways to do that, I usually find them cumbersome. There are also ways to "easily" maintain API references (Swagger, I/O Docs). I posted something about why we don't use these tools not too long ago: http://devo.ps/blog/2013/02/07/why-we-dropped-iodocs-and-swagger.html http://devo.ps/blog/2013/02/07/why-we-dropped-iodocs-and-swa...
- gamache 14y agoThere is -- hypermedia. That's the practice of driving your API by following hyperlinks, rather than by constructing URLs and requesting them. There are several schemes of encoding link information in API resources. I like the Hypertext Application Language, or HAL, the best. Check it out: http://stateless.co/hal_specification.html http://stateless.co/hal_specification.html
- byroot 14y agoThe Github API started to implement it but is now going backwards[0]: Standardize on existing *_url attributes for hypermedia. Remove all _links objects If somebody knows the rational behind it I would love to hear it. [0] http://developer.github.com/ http://developer.github.com/