design/api/README.md
author salimr <riwad.salim@yahoo.fr>
Tue, 09 Oct 2018 10:52:23 +0200
changeset 162 1fd73fdaf4c6
parent 116 672e3c4bbd0c
permissions -rw-r--r--
Add ReadOnlySession component and message when session list is empty

# Generation of API documentation

The documentation use the api blueprint format ([documentation](https://apiblueprint.org)).

[Aglio](https://github.com/danielgtaylor/aglio) is used for rendering the documentation into html.

## install Aglio

```bash
$ npm install
```

### Available commands

- Build the documentation (file metacategory.html)
```bash
$ npm run build
```

This runs the following command:
```bash
$ aglio -i metacategory.apib -o metacategory.html
```

- Watch the documentation.
```bash
$ npm run watch
```

This runs the following command:
```bash
aglio -i metacategory.apib -s
```