github-mirrors/wekan
1
0
Fork 0
mirror of https://github.com/wekan/wekan.git synced 2025-04-20 12:07:11 -04:00
Code Issues Projects Releases Packages Wiki Activity
wekan/openapi
History
Exact
Benjamin Tissoires d7243bba77 openapi: also ignores ThrowStatement 
This gives an error in the resulting file, which makes it not OpenAPI
compatible (not yaml actually).

Fixes #4917

Signed-off-by: Benjamin Tissoires <benjamin.tissoires@gmail.com>
2023-05-09 10:13:23 +02:00
..
generate_openapi.py openapi: also ignores ThrowStatement 2023-05-09 10:13:23 +02:00
README.md - More whitelabeling. 2019-03-21 20:27:21 +02: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 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

or

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