我应该将生成的邮递员文档保存在哪里？答案

【问题标题】：Where should I keep my generated postman documentation?我应该将生成的邮递员文档保存在哪里？
【发布时间】：2020-09-28 11:40:14
【问题描述】：

我发现邮递员允许根据我的收藏和路线创建文档。我有一个 API 存储库。这些路由基本上是来自满足查询的数据库（可能已过滤）的返回报告。目前我们有一个非常不专业的 API 文档，我想使用 Postman 生成一个专业的文档。正如我从邮递员文档中了解到的那样，我可以分享它。基本上我想在我的主页上有一个“文档”按钮，它将引导我进入生成的邮递员文档（在同一个 DNS 下）。我的问题是显示邮递员页面的正确方法是什么？我应该在我的存储库中保留一份邮递员 API 文档的副本吗？还是邮递员允许以其他方式进行操作？我只是不明白如何正确地向用户显示它以及如何跟踪文档。据我了解，我应该把它放在某个地方。但是在哪里以及如何？

【问题讨论】：

标签： postman

【解决方案1】：

您的 Postman 文档应该从您的消费者最有可能发现的任何地方链接。在单个门户中具有指向多个文档的多个链接是很常见的。在 Postman 中运行按钮也是嵌入到我们的文档或门户中的好方法。这是 Postman 的参考实现，它显示了链接到 Postman 文档的一种可能方式 - http://developers.union.fashion/。

【讨论】：

【解决方案2】：

如果您希望在本地生成文档，可以使用我创建的工具 - https://github.com/karthiks3000/postman-doc-gen

您可以生成 HTML 文档并将其托管在您想要的任何位置（连同您的 API 或将其发布到汇合页面或其他地方）。

我还详细介绍了如何将生成的文档与 API 一起托管在 Spring Boot 应用程序 here

【讨论】：