Postman 中的 API 文档是什么?
默认情况下,我们可以为 Postman 中使用的 API 生成文档。此文档可以私下或公开共享。Postman 在集合上创建和托管文档,这些文档可以通过浏览器实时同步。此外,此文档有助于在团队和其他利益相关者之间共享公共 API。
在 Postman 中创建 API 文档的步骤如下所示:
步骤 1 - 点击侧边栏中集合名称旁边的箭头。要为此集合添加描述,请点击“添加描述”链接。
步骤 2 - 将打开一个编辑框。输入一些描述,然后点击“保存”。
步骤 3 - 点击“运行”按钮右侧的三个点。然后点击“公共文档”。
步骤 4 - 我们将导航到 Postman 登录页面。如果我们已经登录,我们将直接进入步骤 7。
步骤 5 - 登录到 Postman 帐户后,我们将在“运行”按钮右侧找到“在 Web 中查看”。这将在点击侧边栏中集合名称旁边的箭头时显示。
步骤 6 - 点击“在 Web 中查看”后,我们将能够查看文档。它包含各个请求、环境、授权代码、响应正文等详细信息。
步骤 7 - 在步骤 4 中点击“公共文档”按钮后,将在浏览器中打开一个新页面。
步骤 8 - 我们可以编辑集合版本、环境、自定义域名、样式和其他字段。然后点击屏幕末尾的“发布集合”。
步骤 9 - 我们的集合将发布成功消息。我们还将获得文档的 URL。此外,我们可以修改或删除集合的发布。
广告