Aaltronav/dougal-software
1
0
Fork 0
mirror of https://gitlab.com/wgp/dougal/software.git synced 2025-12-06 12:27:07 +00:00
Code Issues Packages Projects Releases Activity

Add API documentation

Browse Source
This commit is contained in:
D. Berge
2020-10-23 11:09:08 +02:00
parent 46d489c91f
commit b4decd018a
24 changed files with 3977 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
lib/www/server/README.md
View File

@@ -34,3 +34,13 @@ The following environment variables affect the behaviour of the application:
* `DOUGAL_API_CONFIG`: Location of the API configuration file. Default is `$HOME/etc/www/config.json`.
The server always listens on 127.0.0.1. Use a proxy like Nginx to expose it to the network.
## Use
The API specification may be found under [`./spec`](./spec).
Generate the documentation with:
```bash
./node_modules/.bin/redoc-cli bundle ./spec/openapi.yaml
```