Skip to content
This repository has been archived by the owner on May 24, 2022. It is now read-only.

Backend documentation

Maarten Steevens edited this page May 22, 2022 · 2 revisions

REST API Documentation

The documentation for REST API provided by the backend can be found by in /docs/osoc.yaml. If you want to view this in a more graphical way, you can load it into the swagger editor.

Code

For the code, you can generate documentation by running ./mvnw dokka:dokka. This will generate a collection of HTML files using dokka which can be viewed in your browser.

Clone this wiki locally