o2r Web API
Project description: https://o2r.info
We're a research project, so everything in this API and its documentation is subject to change.
The "working" state should always be in the
master branch, which is published online at https://o2r.info/api, and open pull requests reflect features under development.
The docs are build dynamically based on
index.html is opened in a browser.
You can do this locally by starting a web browser in the
docker run --rm -it -v $(pwd)/docs:/usr/share/nginx/html:ro nginx
Then open http://localhost/index.html.
You can render the
openapi.yml in this repository with redoc-cli tool.
The output is a a zero-dependency static HTML file in your current directory.
#npm i -g redoc-cli redoc-cli bundle docs/openapi.yml
Our combination of the
openapi.yml and ReDoc's
redoc.standalone.js will render a html which is then deployed via the
/docs folder. Our script
redoc_theme.js contains the actual ReDoc initialization command and makes a few style changes through callback functions to correspond to our project.
The css rules which expand the core ReDoc style are in the
Github pages build
The pages at https://o2r.info/api/ are built locally by developers on relevant changes.
The website is served from the directory
/docs, which must be configured in the repository settings.
You can serve the HTML page (without style changes!) and automatically re-rendering on changes with
redoc-cli serve --watch docs/openapi.yml
The o2r Web API specification is licensed under Creative Commons CC0 1.0 Universal License, see file
To the extent possible under law, the people who associated CC0 with this work have waived all copyright and related or neighboring rights to this work.
This work is published from: Germany.