apitech
/
wekan
mirror of https://github.com/wekan/wekan
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
The Open Source kanban (built with Meteor). Keep variable/table/field names camelCase. For translations, only add Pull Request changes to wekan/i18n/en.i18n.json , other translations are done at https://transifex.com/wekan/wekan only.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
5253 Commits
1 Branch
818 Tags
111 MiB
Tag: Branch: Tree: 8648e32108
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '8648e32108'
${ noResults }
wekan/openapi/README.md

28 lines
797 B
Raw Normal View History Unescape

Add OpenAPI description of the REST API The API is generated by a custom script that parses the models directory. Once the API is generated, tools like https://editor.swagger.io/ or Python bravado can parse the file and generate a language friendly API. Note that the tool generate an OpenAPI 2.0 version because bravado doesn't handle OpenAPI 3.0. The script also parses the JSDoc with a custom parser to allow customization of the description of the fields.
7 years ago
# 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):
- More whitelabeling. Thanks to xet7 !
6 years ago
api2html -c ../public/logo-header.png -o api.html ../public/wekan_api.yml
Add OpenAPI description of the REST API The API is generated by a custom script that parses the models directory. Once the API is generated, tools like https://editor.swagger.io/ or Python bravado can parse the file and generate a language friendly API. Note that the tool generate an OpenAPI 2.0 version because bravado doesn't handle OpenAPI 3.0. The script also parses the JSDoc with a custom parser to allow customization of the description of the fields.
7 years ago
or
redoc-cli serve ../public/wekan_api.yml