我应该把我生成的postman文档保存在哪里?

问题描述 投票:0回答:1

我发现postman允许根据我的集合和路由创建一个文档。我有一个存储库,它是一个API。这些路由基本上是来自DB的返回报告(可能是过滤过的),这些报告符合查询的要求。目前我们有一个非常不专业的API文档,我想用Postman来生成一个专业的文档。根据我从postman文档中了解到的情况,我可以把它分享给大家。基本上,我想在我的主页上有一个 "文档 "按钮,这将引导我到生成的postman文档(在同一个DNS下)。我的问题是,显示postman页面的正确方式是什么?我是否应该在我的仓库中保留一份postman API文档的副本?还是postman允许用其他方式显示?我只是不明白如何正确地显示给用户以及如何跟踪文档。据我所知,我应该把它放在某个地方。但是在哪里,如何保存?

postman
1个回答
0
投票

如果你想在本地生成文档,你可以使用我创建的一个工具----。https:/github.comkarthiks3000postman-doc-gen。

你可以生成HTML文档,并将其存放在任何你想要的地方(和你的API一起或将其发布到confluence页面或其他地方)。


0
投票

你的Postman文档应该从最有可能被你的消费者发现的地方进行链接。在一个门户中拥有多个链接到多个文档是很常见的。在Postman中运行按钮也是一个很好的方式来嵌入到我们的文档或门户中。这里是Postman的参考实现,展示了一种可能的链接到Postman文档的方式----------。http:/developers.union.fashion。.

© www.soinside.com 2019 - 2024. All rights reserved.