如何在Postman中生成API文档？

我们可以在Postman中生成API文档。大多数公司都会这样做，以帮助开发人员了解API的行为并为他们提供指导。API通常是为内部使用和第三方开发者创建的。

创建API文档的步骤如下所示：

步骤1 - 点击侧边栏中集合名称右侧的箭头。然后点击“添加描述”。

步骤2 - 将出现一个输入字段。输入描述，然后点击“保存”按钮。

步骤3 - 点击“运行”按钮旁边的三个点。然后点击“公共文档”。

步骤4 - 我们将跳转到Postman的登录页面。如果我们之前已经登录，我们将直接跳转到步骤7。

步骤5 - 登录Postman账户后，我们将在“运行”按钮旁边看到“在网页中查看”。这可以通过点击侧边栏中集合名称右侧的箭头来获得。

步骤6 - 点击“在网页中查看”按钮后，我们可以看到文档。它包含有关单个请求、环境、授权代码、响应主体等信息。

步骤7 - 点击步骤4中建议的“公共文档”后，浏览器将导航到一个新页面。

步骤8 - 在这里，我们可以选择编辑集合版本、环境、自定义域名、样式等。最后，点击屏幕底部的“发布集合”。

步骤9 - 集合成功发布。我们可以获取文档的发布URL。此外，我们还可以选择更改或取消发布集合。

更新时间： 2021年6月25日

457 次查看

开启你的职业生涯

通过完成课程获得认证

开始学习
广告