从postman集合创建html doc

时间:2015-03-24 16:35:37

标签: api rest documentation documentation-generation postman

我开发了一个非常优秀的API,我在Postman上有它,它非常好用。现在我必须生成一个html文档,以便将它与我的源代码一起保存在/ docs中。

是否有工具或方法来实现这一目标?我真的不想写所有这些文档。分享邮递员收藏不是一种选择。

4 个答案:

答案 0 :(得分:29)

我最近遇到了同样的问题而我没有找到任何东西。所以我创建了一个简单的工具来完成它。这是一个用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从集合中生成一次性文档。

答案 1 :(得分:16)

我知道这是一个老问题,你现在可能找到了一个解决方案,但你可能对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上提交问题。

答案 2 :(得分:-2)

您也可以尝试我制作的免费工具。它提供.txt中的文档,但您可以使用浏览器将其转换为pdf。

https://postmandoc.herokuapp.com/

答案 3 :(得分:-2)

您可以使用命令安装Newman" npm install -g Newman"然后运行命令" newman运行CollectionName.json -e envVar.json"从保存集合的位置开始,其中CollectionName.json是您的集合名称,enVar.json是一组环境变量。这将在同一文件夹中生成html报告。 一个先决条件是安装节点j。