search

krustowski / tiny-monitor-api

API-first lightweight service-monitoring tool for docker (pre-release)
https://mon.n0p.cz
MIT License
1 stars 0 forks source link

Generated documentation from code #9

Open krustowski opened 3 years ago

krustowski commented 3 years ago

Implement (not fully supported yet) phpdoc/swagger/openapi parsers for documentation to be generated, e.g. by make doc command in the ${APP_ROOT} directory.

Before this task is closed, the API documentation will be written using Dokuwiki and exported as pdf into the repo.

krustowski commented 3 years ago

Currently tested via Swagger UI with OAI3 parsed JSON.

krustowski commented 3 years ago

Can be viewed and tested here

TODO: edit documentation in src/Api.php to be more editable and readable in-line too