从apidoc json转换为markdown。
apidoc2markdown的Python项目详细描述
Apidoc是一个用json或yaml编写restapi文档的开放规范。 尽管它不完美,但事实上它是许多api开发人员的标准。
此扩展允许您将swagger.json文件呈现为降价文档。 您可以通过提供自己的Jinja2模板自定义输出。
警告
此扩展是为特定项目创建的,因此仅 保证与这个特殊的项目合作!很有可能 您必须为项目修改apidoc.md.j2。
安装
$ pip install apidoc2markdown
用法
usage: apidoc2markdown-script.py [-h][-i APIDOC_LOCATION][-o OUTPUT][-t TEMPLATE] optional arguments: -h, --help show this help message and exit -i APIDOC_LOCATION, --input APIDOC_LOCATION path to the directory with api_data.json and api_project.json (default: .) -o OUTPUT, --output OUTPUT path to the output Markdown file (default: swagger.md) -t TEMPLATE, --template TEMPLATE Jinja2 template used for conversion