Last week at OSCON, I wrote about
Mashery's release of their new I/O Docs.
Mashery I/O Docs are a combination of
API documentation and an
API explorer, allowing developers to make requests on an API inline while browsing the API reference materials.
I/O Docs provides an interactive documentation system for RESTful web APIs. By defining APIs at the resource, method and parameter levels in a JSON schema, I/O Docs will generate a JavaScript client interface. API calls can be executed directly from the documentation interface, proxied through the I/O Docs server, producing formatted responses.
Mashery has
open-sourced a version of the I/O Docs on Github, for any API owner to deploy for their own documentation. This version of I/O docs runs on
Node.js and uses
Redis as a data store.
Last year Apigee launched their
API console which allows users to also make calls against an API, and
earlier this year they made it freely available for any API owner to deploy. The API console is a popular tool with developers to get up and going using an API, and build an understanding how an API works. Apigees move to make free was a significant market play, and definitely built awareness of their platform.
Masherys approach to API exploration reflects an alternative view from Apigees, one that integrates API discovery with API documentation, as opposed to being an entirely separate tool. Masherys move to open-source their I/O Docs on Github, is great to see. I'm sure it will definitely attract more attention to their platform and tools.
You can
download or fork the Mashery I/O Docs on Github, and find necessary installation info and documentation.
