seshata - Create your interactive API
seshata is a new way to document your API, without documenting anything at all! Just let your users try it, live!
It's simple, first you define all your API calls available
Second, when a user clicks on a specific API call, he gets a live answer
No more mockups, no more non-updated documentation (well, sort of, I'm sure there is a 'lil' more to go to find the panacea of documentation :))
How to use
Map your api in a api-map.json
file:
"title": "my API docs" "api-calls": "id": "route-user" "method": "GET" "data-route": "/api/user" "simple-route": "/api/user" "data-target": "route-user" "data-body": {} "data-truncate": "20" ...
full example here
Download the module by
$ git clone git@github.com:diasdavid/seshata.git$ cd seshats$ npm link
or(once it is on NPM)
$ npm install -g seshata
After this, all you need to gen your API Docs is:
$ seshata gen <api-map.json> [<output-folder>]
Want to try it out first?
$ git clone git@github.com:diasdavid/seshata.git$ cd seshata/seshata-playground$ seshata gen api-map.json$ npm install$ node index.js# open your browser in localhost:8080
Why seshata?
"In Egyptian mythology, Seshata (also spelled Safkhet, Sesat, Seshet, Sesheta, and Seshata) was the Ancient Egyptian goddess of wisdom, knowledge, and writing."
Source: Wikipedia
Acknowledgements
The original idea for seshata is from Pedro Teixeira, he was the one having the vision and suggested me to do it :) Thank you Pedro! Also, it was inspired by the sls-sample-app-coobook, which uses this interactive technique