mirror of
https://github.com/wekan/wekan.git
synced 2026-11-17 00:45:55 -05:00
openapi/generate_openapi.py's header and the models' JSDoc said "Wekan REST API", "extend Wekan", "a production Wekan server" and "in the Wekan board", so every release's API pages on wekan.fi failed its brand-spelling check (v12.95-v12.97 did). The generator, the model comments and public/api/wekan.yml now say WeKan, and tests/openapiBrandSpelling.test.cjs checks the generated file, the generator header and every model JSDoc block. Thanks to xet7 !
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 v7.92 > ../public/api/wekan.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
or
redoc-cli serve ../public/wekan_api.yml