mirror of https://github.com/wekan/wekan.git synced 2025-12-16 15:30:13 +01:00

History

Lauri Ojansivu 37c5436087 Some checks are pending Docker / build (push) Waiting to run Details Docker Image CI / build (push) Waiting to run Details Release Charts / release (push) Waiting to run Details Test suite / Meteor tests (push) Waiting to run Details Test suite / Coverage report (push) Blocked by required conditions Details v8.02		2025-10-14 11:58:14 +03: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

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

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