This is a site for providing documentation for the pilot project DELING API. It is hosted at https://skat.github.io/deling-api-docs.
The documentation is written with API Blueprint for the DELING project. If you have comments, change requests or similar, please add it as an issue and we will have a look at it.
For calling the API, replace localhost in the API documentation with the endpoint you have received from us.
The framework is provided by aglio, and converts the deling-api.md to html.
Postman collections are also provided for Car, Boat and Service API. To import the collections, use a version of Postman that supports Collection v2.1.
Update the documentation file deling-api.md, and open a pull request to suggest changes.
To run the documentation locally you should have this repository checked out.
npm install -g aglio
aglio --theme-template triple -i deling-api.md -s
The master branch is published as a GitHub page. It is published when a new change to index.html is pushed to master. To update index.html, run:
aglio --theme-variables flatly -i deling-api.md --theme-template triple -o index.html