mirror of https://github.com/wekan/wekan.git synced 2025-04-21 12:37:07 -04:00

Lauri Ojansivu 2969161afb - More whitelabeling.

Thanks to xet7 !

2019-03-21 20:27:21 +02:00

797 B

Raw Permalink Blame History

OpenAPI tools and doc generation

Open API generation

This folder contains a script (generate_openapi.py) that extracts the REST API of Wekan and exports it under the OpenAPI 2.0 specification (Swagger 2.0).

dependencies

python3
esprima-python

calling the tool

python3 generate_openapi.py --release v1.65 > ../public/wekan_api.yml

Generating docs

Now that we have the OpenAPI, it's easy enough to convert the YAML file into some nice Markdown with shins and api2html, or even ReDoc:

api2html -c ../public/logo-header.png -o api.html ../public/wekan_api.yml

redoc-cli serve ../public/wekan_api.yml

797 B Raw Permalink Blame History