Postman: 如何从Postman导出/下载API文档？

Question

我在Postman中创建了一组包含多个API端点的集合。我可以将团队成员添加到我的Postman工作区，并且还可以公开共享文档链接。但我想要一个下载链接，以便将文档作为文件夹下载并添加到我的项目中。我是否错过了在Postman中提供此功能的相关设置？

- Siddiqui Noor

Answer 1

您可以像其他答案中所示一样将集合导出为json，然后运行工具将其转换为HTML文档，您可以在任何地方托管它。

我创建了一个简单的Python可执行文件来完成这个任务 - https://github.com/karthiks3000/postman-doc-gen

- karthiks3000

---

哇！太棒了！！ - Siddiqui Noor

太好了！完美的脚本！ - ssavva05

@SiddiquiNoor 如果这个答案对您有用，请接受它。这将帮助其他成员快速找到相关的答案。 - Manonandan S K

@ManonandanSK，是的，Karthiks3000提供的解决方案在某种程度上起作用了，但它仍然没有被添加到Postman服务中。我已经点赞了这个答案，仍在等待Postman中的任何自动化功能。 - Siddiqui Noor

我们应该如何从Postman文档页面获取JSON？正如你所说的，它不像“其他答案中显示的那样”。 - S.Serpooshan

Answer 2

您好@Siddiqui，目前这个功能还不可用，我会通过进入我的收藏文档并在显示打印提示时将其打印出来，然后保存为PDF文件，在最终确定打印选项之前。一旦我得到PDF文件，我就可以按照自己的想法进行各种选择。这是我最接近下载我的收藏文档的方式。

出于隐私考虑，我已经删除了部分信息。 希望这可以帮助您，如果需要进一步帮助，请留下评论。

- Moeez Mazhar

Answer 3

Postman生成的API文档旨在通过工作区和URL进行共享和消费，以确保其保持最新状态并不会过时。由于文档很可能经常更新示例、新端点和其他元素，因此任何下载的内容都很快就会过时。我知道PDF版本已被讨论作为未来发布的一部分，但保持API文档最新是首要任务。

- kinlane

---

我认为这是一个非常必要的功能，因为大多数需要批准API的人不会查看分享给他们的URL，而大多数企业类型的讨论都是通过电子邮件或Confluence进行的。目前还没有办法将文档提取为PDF文件并作为附件发送。 - Happy Coder

我理解保持一切更新的重要性，但强制将其保留在Postman环境中只是多了一个项目管理步骤。 - Saucepan

一个人的恐怖分子是另一个人的自由斗士。一个人所说的“确保它保持最新并且不会停滞不前”是另一个人所说的“确保你被锁定在我们（Postman）的订阅计划中”。最近，Postman出现了大规模停机事件，在我们公司中，我们无法使用文档和工作区。我会毫不犹豫地用OpenAPI来替代Postman。 - Ricardo

Answer 4

一个简单的解决方法是从网络浏览器中将页面打印为PDF格式。虽然不是完美的，但也可以使用。

- user1491929

Answer 5

https://learning.postman.com/docs/getting-started/importing-and-exporting-data/导出文档为JSON格式，然后运行@karthiks3000的脚本（https://github.com/karthiks3000/postman-doc-gen）

- GetGetCoded

---

这个答案已经被@karthiks3000给出了，但我正在寻找一个在Postman内部的解决方案。 - Siddiqui Noor