从postman集合创建html doc

Question

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

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

Answer 1

我最近有同样的问题,我没有找到任何东西.所以我创建了一个简单的工具来完成它.这是一个用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

更新2:功能请求(请参阅UPDATE1)已关闭,并且已向Postman云添加了创建文档的可能性.以下是功能请求结束评论:

这是Postman Cloud的一部分:http://blog.getpostman.com/2015/12/10/introducing-postman-cloud/.云托管,更新和维护每个人的文档.我建议http://docman.launchrock.com/和https://github.com/JakeWorrell/docodile从Collections生成一次性文档.

Answer 2

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