从邮递员集合中创建 html 文档
Creating html doc from postman collection
我开发了一个相当广泛的 API,我在 Postman 上安装了它,效果非常好。现在我必须生成一个 html 文档以将其与我的源代码一起保存在 /docs 中。
是否有工具或方法可以实现此目的?我真的不想写所有这些文档。共享 postman 集合不是一个选项。
我最近遇到了同样的问题,但我没有找到任何东西。所以我创建了一个简单的工具来做到这一点。这是一个非常基本的 javascript 应用程序,用 react.js 编写。目前它是非常基础的,但我正在努力,所以欢迎任何功能请求。
您可以在以下位置免费使用它:http://www.vernizzis.it/docman/
此外,您还可以在以下位置获取代码并进行修改:https://github.com/davidevernizzi/docman
欢迎任何评论。
UPDATE1:环顾四周我也发现了这个项目:https://github.com/JakeWorrell/docodile
此功能要求:https://github.com/a85/POSTMan-Chrome-Extension/issues/204
UPDATE2:功能请求(参见 UPDATE1)已关闭,创建文档的可能性已添加到 Postman 云中。这是功能请求结束评论:
This is available as part of Postman Cloud: http://blog.getpostman.com/2015/12/10/introducing-postman-cloud/. Cloud hosts, updates and maintains documentation for everyone. I'd suggest http://docman.launchrock.com/ and https://github.com/JakeWorrell/docodile for generating one-time documentation from Collections.
我知道这是一个老问题,你现在可能已经找到了解决方案,但你可能会对 Postmanerator 感兴趣:https://github.com/aubm/postmanerator
基本上,这是从命令行使用它的方式:
postmanerator -collection=/path/to/your/collection.js -output=/path/to/doc.html
要安装它,请下载最新的 Github 版本。您需要根据您的系统选择合适的二进制文件。然后把它放在你的路径中的某个地方。
如果需要更多信息,请参阅自述文件中的文档。从那里您会找到有关充分利用该工具的建议,或使用自定义主题更改文档的外观。
Github 演示文稿还提供了对生成的示例文档的参考。
您还将了解如何利用 Travis 等 CI 平台,使用 Postmanerator 自动生成和发布文档。
由于这是我目前正在从事的开源项目,如果您有任何可以改进它的想法,请随时在 Github 上提交问题。
你也可以试试我制作的免费工具。它以 .txt 格式提供文档,但您可以使用浏览器将其转换为 pdf。
您可以使用命令 "npm install -g Newman" 安装 Newman,然后从保存 collection 的位置 运行 命令 "newman run CollectionName.json -e envVar.json" 安装 Newman,其中 CollectionName.json是您的 collection 名称,enVar.json 是环境变量集。这将在同一文件夹中生成 html 报告。
一个先决条件是安装 node js。
我开发了一个相当广泛的 API,我在 Postman 上安装了它,效果非常好。现在我必须生成一个 html 文档以将其与我的源代码一起保存在 /docs 中。
是否有工具或方法可以实现此目的?我真的不想写所有这些文档。共享 postman 集合不是一个选项。
我最近遇到了同样的问题,但我没有找到任何东西。所以我创建了一个简单的工具来做到这一点。这是一个非常基本的 javascript 应用程序,用 react.js 编写。目前它是非常基础的,但我正在努力,所以欢迎任何功能请求。
您可以在以下位置免费使用它:http://www.vernizzis.it/docman/
此外,您还可以在以下位置获取代码并进行修改:https://github.com/davidevernizzi/docman
欢迎任何评论。
UPDATE1:环顾四周我也发现了这个项目:https://github.com/JakeWorrell/docodile 此功能要求:https://github.com/a85/POSTMan-Chrome-Extension/issues/204
UPDATE2:功能请求(参见 UPDATE1)已关闭,创建文档的可能性已添加到 Postman 云中。这是功能请求结束评论:
This is available as part of Postman Cloud: http://blog.getpostman.com/2015/12/10/introducing-postman-cloud/. Cloud hosts, updates and maintains documentation for everyone. I'd suggest http://docman.launchrock.com/ and https://github.com/JakeWorrell/docodile for generating one-time documentation from Collections.
我知道这是一个老问题,你现在可能已经找到了解决方案,但你可能会对 Postmanerator 感兴趣:https://github.com/aubm/postmanerator
基本上,这是从命令行使用它的方式:
postmanerator -collection=/path/to/your/collection.js -output=/path/to/doc.html
要安装它,请下载最新的 Github 版本。您需要根据您的系统选择合适的二进制文件。然后把它放在你的路径中的某个地方。
如果需要更多信息,请参阅自述文件中的文档。从那里您会找到有关充分利用该工具的建议,或使用自定义主题更改文档的外观。
Github 演示文稿还提供了对生成的示例文档的参考。
您还将了解如何利用 Travis 等 CI 平台,使用 Postmanerator 自动生成和发布文档。
由于这是我目前正在从事的开源项目,如果您有任何可以改进它的想法,请随时在 Github 上提交问题。
你也可以试试我制作的免费工具。它以 .txt 格式提供文档,但您可以使用浏览器将其转换为 pdf。
您可以使用命令 "npm install -g Newman" 安装 Newman,然后从保存 collection 的位置 运行 命令 "newman run CollectionName.json -e envVar.json" 安装 Newman,其中 CollectionName.json是您的 collection 名称,enVar.json 是环境变量集。这将在同一文件夹中生成 html 报告。 一个先决条件是安装 node js。