# seshata

> generate an interactive api docs for your app

Latest version **0.3.2** (published 2014-02-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install seshata
pnpm add seshata
yarn add seshata
bun add seshata
```

Provides the command `seshata`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.2 |
| Published | 2014-02-23 |
| First published | 2014-02-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Known vulnerabilities | 0 (+11 in 2 direct dependencies) |
| Install scripts | no |
| Author | David Dias |
| Maintainers | daviddias |
| Keywords | docs, api, interactive |

## Links

- npm: https://www.npmjs.com/package/seshata
- Repository: https://github.com/diasdavid/seshata
- Issues: https://github.com/diasdavid/seshata/issues
- npm.io page: https://npm.io/package/seshata

## Dependencies (9)

- [ncp](https://npm.io/package/ncp.md) ~0.5.0
- [brfs](https://npm.io/package/brfs.md) ~0.1.0
- [read](https://npm.io/package/read.md) ~1.0.5
- [colors](https://npm.io/package/colors.md) ~0.6.2
- [buzzard](https://npm.io/package/buzzard.md) ~0.1.2
- [optimist](https://npm.io/package/optimist.md) ~0.6.0
- [browserify](https://npm.io/package/browserify.md) ~3.28.1
- [handlebars](https://npm.io/package/handlebars.md) ~1.3.0
- [node-static](https://npm.io/package/node-static.md) ~0.7.3

## Recent versions

- 0.3.2 (latest) — 2014-02-23
- 0.3.1 — 2014-02-12
- 0.2.0-1 — 2014-02-10
- 0.2.0 — 2014-02-10

## README

**seshata** - Create your interactive API
============
[![Gitter chat](https://badges.gitter.im/diasdavid/seshata.png)](https://gitter.im/diasdavid/seshata)
[![](https://david-dm.org/diasdavid/seshata.png)](https://david-dm.org/diasdavid/seshata)
[![devDependency Status](https://david-dm.org/diasdavid/seshata/dev-status.png)](https://david-dm.org/diasdavid/seshata#info=devDependencies)

**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

![](https://i.cloudup.com/36dV5tgoeP-3000x3000.png)

#### Second, when a user clicks on a specific API call, he gets a live answer

![](https://i.cloudup.com/eABDXnuXf0-3000x3000.png)

#### 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:

```javascript
{
 "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](https://github.com/diasdavid/seshata/blob/master/seshata-playground/api-map.json)

Download the module by

```bash
$ git clone git@github.com:diasdavid/seshata.git
$ cd seshats
$ npm link
```

or(once it is on NPM)
```bash
$ npm install -g seshata
```

After this, all you need to gen your API Docs is:
```bash
$ seshata gen <api-map.json> [<output-folder>]
```

### Want to try it out first?

```bash
$ 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](http://upload.wikimedia.org/wikipedia/commons/thumb/7/71/Seshat.svg/200px-Seshat.svg.png)

"In Egyptian mythology, Seshata (also spelled Safkhet, Sesat, Seshet, Sesheta, and Seshata) was the Ancient Egyptian goddess of wisdom, knowledge, and writing."

Source: [Wikipedia](http://en.wikipedia.org/wiki/Seshat)

### Acknowledgements

The original idea for seshata is from [Pedro Teixeira](https://github.com/pgte), 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](https://github.com/strongloop/sls-sample-app-cookbook), which uses this interactive technique

---
_Source: https://npm.io/package/seshata · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._