github-mirrors/wekan
1
0
Fork 0
mirror of https://github.com/wekan/wekan.git synced 2025-06-27 08:49:48 -04:00
Code Issues Projects Releases Packages Wiki Activity
wekan/openapi
History
Exact
Yang, Bo f399b5119f feat: enhance API documentation and add board-related endpoints 
Previously, boards.js contains a `?.` operator, which is not supported by esprima, therefore boards.js is skipped.

This PR fixes the API generation for borads.js by removing `?.`.

See https://github.com/jquery/esprima/issues/2112
2025-06-23 20:01:38 +00:00
..
generate_openapi.py fix: properly document /users/login 2025-06-12 02:18:19 +00:00
README.md feat: enhance API documentation and add board-related endpoints 2025-06-23 20:01:38 +00:00

README.md

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

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