jakeworrell/docodile

此软件包的最新版本(0.2)没有可用的许可证信息。

从Postman收集生成API文档

0.2 2015-02-03 17:46 UTC

This package is not auto-updated.

Last update: 2024-09-28 17:17:49 UTC


README

从Postman收集生成HTML API文档

目前的代码很糟糕

用法

首先不要忘记运行composer install

./docodile generate /path/to/postman/collection.json /my/output/directory

如果/my/output/directory已存在,则进程将退出,因为继续将会完全删除该目录。--force将强制删除

--url: 添加URL选项。例如: "http://helloworld.com"

主题

Docodile现在支持从bootswatch(https://bootswatch.com/3/)和highlightjs的捆绑样式(https://highlightjs.org/)切换主题

例如: ./docodile generate ../core/webservice/docs/Core.json.postman_collection output --force -blumen -jgruvbox-light 这将使用lumen主题作为整体CSS,并使用gruvbox-light样式进行所有语法高亮显示