从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

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java我可以在J2EE1.4中使用JAXR吗   YouTube数据API超出了未经验证的java每日使用限制   java RED5 RTMPConnManager未设置applicationContext局部变量。这会导致NullPointerException   java多部分/formdata,加载图像(安卓)   java Struts 2<s:select>填充表单中的其他字段   java Eclipse在迁移后不会将邮件属性传递给Spring Boot   java如何检查请求的TLS版本   java如何从包中导入相同的类   如何在java中将BLOB字符串转换为人类可读的格式字符串   java使用Play映射特定的文件路径!框架   java Eclipse重构   在子字符串上使用“预定义字符类”的java   java如何在SeleniumWebDriver中选择li中的锚定标记?   jspjava。木卫一。FileNotFoundException:系统找不到指定的路径   java Hi,在启动cmd\design javafx\cmd eclipse时,我的文件不是删除的,也不是复制的   java Selenium Web驱动程序异常“找不到:taskkill的可执行文件”   java如何获得数组的迭代器?