ses

seshata

seshat is a new way to document your API, without documenting anything at all! Just let your users try it, live!

Showing:

Popularity

Downloads/wk

0

GitHub Stars

3

Maintenance

Last Commit

8yrs ago

Contributors

0

Package

Dependencies

9

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

seshata - Create your interactive API

Gitter chat devDependency Status

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?

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial