从邮递员集合创建 html 文档 [英] Creating html doc from postman collection

问题描述

我开发了一个非常扩展的 API，我在 Postman 上有它，效果很好.现在我必须生成一个 html 文档，以将它与我的源代码一起保存在/docs 中.

I've developed a pretty extense API, and I have it on Postman, which works pretty nice. Now I have to generate an html doc to keep it versioned inside /docs along with my sources.

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

Is there a tool or a way to achieve this? I really don't want to write all this documentation. Sharing the postman collection is not an option.

推荐答案

我最近遇到了同样的问题，但没有找到任何东西.所以我创建了一个简单的工具来做到这一点.这是一个用 react.js 编写的非常基本的 javascript 应用程序.目前它是非常基础的，但我正在研究它，所以欢迎任何功能请求.

I recently had the same problem and I did not find anything. So I created a simple tool to do it. It is a very basic javascript application written with react.js. At the moment it is very basic, but I'm working on it, so any feature request is welcome.

您可以在以下网址免费使用:http://www.vernizzis.it/docman/

You can use it for free at: http://www.vernizzis.it/docman/

此外，您可以在以下位置获取代码并进行修改:https://github.com/davidevernizzi/docman

Plus you can get the code and modify it at: https://github.com/davidevernizzi/docman

欢迎任何评论.

UPDATE1:环顾四周我也发现了这个项目:https://github.com/JakeWorrell/docodile以及此功能请求:https://github.com/a85/POSTMan-Chrome-Extension/issues/204

UPDATE1: looking around I also found this project: https://github.com/JakeWorrell/docodile and this feature request: https://github.com/a85/POSTMan-Chrome-Extension/issues/204

UPDATE2:功能请求(参见 UPDATE1)已关闭，并且已将创建文档的可能性添加到 Postman 云中.这是功能请求结束评论:

UPDATE2: the feature request (see UPDATE1) has been closed and the possibility of creating documentation has been added to Postman cloud. Here is the feature request closing comment:

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

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.

这篇关于从邮递员集合创建 html 文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！