2 ms·
API documentation tool: If you have a REST(ish) API, the tool would allow you to: * Describe the authentication * Enter all the objects, methods, URL endpoint
by callmeed 13y ago
API documentation tool: If you have a REST(ish) API, the tool would allow you to:
* Describe the authentication
* Enter all the objects, methods, URL endpoints, and parameters of your API
The tool would then:
* Generate pretty documentation, including example requests/responses
* Include a working web-based API console (like Mashery has)
* Auto-generates client libraries in Ruby, Python, PHP, Node, Obj-C, etc. and keep them updated in GitHub
Bonus points for bootstrapping the API information from your Rails routes file.
- intelekshual 13y agoRAML promises most of this: http://raml.org/ http://raml.org/ Specifically, check out the projects section, which includes: an API designer, an API console and a documentation generator.
- sunir 13y agoLike http://apiary.io http://apiary.io ?
- dabernathy89 13y agoHoly crap, that looks fantastic.
- dcposch 13y agoI like Apiary a lot so far