<commit_before>**seshat** - Create your interactive API
============

**seshat** 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 this 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/seshat/blob/master/seshat-playground/api-map.json)

Download the module by
<commit_msg>readme update<commit_after>**seshat** - Create your interactive API
============

**seshat** 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 this 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/seshat/blob/master/seshat-playground/api-map.json)

Download the module by

{'fraction_non_alphanumeric': 0.1634980988593156, 'fraction_numerical': 0.02091254752851711, 'mean_word_length': 3.403765690376569, 'pattern_counts': {'":': 18, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2291724', 'n_tokens_mistral': 757, 'n_tokens_neox': 693, 'n_words': 227}