我开发了一个非常广泛的 API，我在 Postman 上使用它，效果很好。现在我必须生成一个 html 文档，以将它与我的源代码一起保存在 /docs 中。
是否有工具或方法可以实现这一目标？我真的不想写所有这些文档。共享邮递员收藏不是一种选择。
【问题讨论】：
.md文件
标签： api rest documentation documentation-generation postman
您可以使用命令“npm install -g Newman”安装 Newman，然后从保存集合的位置运行命令“newman run CollectionName.json -e envVar.json”，其中 CollectionName.json 是您的集合name 和 enVar.json 是一组环境变量。这将在同一文件夹中生成 html 报告。 一个先决条件是安装 node js。
【讨论】：
你也可以试试我制作的免费工具。它以 .txt 格式提供文档，但您可以使用浏览器将其转换为 pdf。
【讨论】：
我知道这是一个老问题，您现在可能已经找到了解决方案，但您仍然可能对 Postmanerator 感兴趣：https://github.com/aubm/postmanerator
基本上，这是您从命令行使用它的方式：
postmanerator -collection=/path/to/your/collection.js -output=/path/to/doc.html
要安装它，请下载最新的 Github 版本。您需要根据您的系统选择适当的二进制文件。然后将它放在 PATH 中的某个位置。
如果您需要更多信息，请参阅自述文件中的文档。从那里您将找到充分利用该工具的建议，或使用自定义主题更改文档的外观。
Github 演示文稿还提供了对生成的示例文档的参考。
您还将了解如何利用 Travis 等 CI 平台，使用 Postmanerator 自动生成和发布文档。
由于这是我目前正在进行的一个开源项目，如果您有任何可以改进它的想法，请随时在 Github 上提交问题。
【讨论】：
我最近遇到了同样的问题，但我没有找到任何东西。所以我创建了一个简单的工具来做到这一点。这是一个用 react.js 编写的非常基本的 javascript 应用程序。目前它是非常基本的，但我正在努力，所以欢迎任何功能请求。
您可以免费使用它：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 云。以下是功能请求结束评论：
这作为 Postman Cloud 的一部分提供：http://blog.getpostman.com/2015/12/10/introducing-postman-cloud/。云托管、更新和维护每个人的文档。我建议使用 http://docman.launchrock.com/ 和 https://github.com/JakeWorrell/docodile 从 Collections 生成一次性文档。
【讨论】：
... 按钮，然后点击Export 来获取该文件。然后可以将该文件的原始 JSON 内容粘贴到 @DavideVernizzi 的文档生成工具中。