如何在 Postman 中生成 API 文档?
postmanrest apisoap api更新于 2026/2/16 20:07:17
我们可以在 Postman 中生成 API 文档。大多数公司都会这样做，以帮助开发人员理解 API 的行为并指导他们。API 通常供内部使用和第三方开发人员使用。
创建 API 文档的步骤如下 −
步骤 1 − 点击侧边栏中集合名称右侧的箭头。然后点击"添加描述"。
步骤 2 − 将出现一个输入字段。输入描述，然后点击"保存"按钮。
步骤 3 − 点击"运行"按钮旁边的三个点。然后点击"公共文档"。
步骤 4 − 我们将转到 Postman 的登录页面。如果我们之前已经登录，我们将直接进入步骤 7。
步骤 5 −登录 Postman 帐户后，我们将在"运行"按钮旁边看到"在网页中查看"。点击侧边栏中"集合"名称右侧的箭头即可看到此功能。
步骤 6 − 点击"在网页中查看"按钮后，我们就可以看到文档了。它包含有关各个请求、环境、授权码、响应主体等信息。
第 7 步 −按照步骤 4 中的提示点击"公共文档"后，浏览器将导航到一个新的页面。
步骤 8 − 在这里，我们可以编辑集合版本、环境、自定义域、样式等。最后，点击屏幕底部的"发布集合"。
步骤 9 − 集合已成功发布。我们可以获取文档的已发布 URL。此外，我们还可以选择更改或删除已发布的集合。
