diff options
author | Lauri Ojansivu <x@xet7.org> | 2019-01-19 21:09:42 +0200 |
---|---|---|
committer | Lauri Ojansivu <x@xet7.org> | 2019-01-19 21:09:42 +0200 |
commit | 3257f78d24cf1abde3bffd5c22b681a0edb86494 (patch) | |
tree | 5144415f5805558d0535b47ae18b3430b55f33e1 /openapi/README.md | |
parent | 8e8147b5acdf8639d5f164efc2acfb4efd12ff8a (diff) | |
parent | a9133bf933c4e49b5ef0213e598c315570333202 (diff) | |
download | wekan-3257f78d24cf1abde3bffd5c22b681a0edb86494.tar.gz wekan-3257f78d24cf1abde3bffd5c22b681a0edb86494.tar.bz2 wekan-3257f78d24cf1abde3bffd5c22b681a0edb86494.zip |
Merge branch 'bentiss-openapi' into devel
Diffstat (limited to 'openapi/README.md')
-rw-r--r-- | openapi/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/openapi/README.md b/openapi/README.md new file mode 100644 index 00000000..c353ffd4 --- /dev/null +++ b/openapi/README.md @@ -0,0 +1,27 @@ + +# 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](https://github.com/Kronuz/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](https://github.com/Mermade/shins) and [api2html](https://github.com/tobilg/api2html), +or even [ReDoc](https://github.com/Rebilly/ReDoc): + + api2html -c ../public/wekan-logo-header.png -o api.html ../public/wekan_api.yml + +or + + redoc-cli serve ../public/wekan_api.yml |