查看文档

文档可帮助您充分利用您在 Postman 中使用的集合和 API。查看文档以了解有关集合中的请求或如何与 API 端点交互的更多信息。

默认情况下，集合或 API 的文档是私有的。您可以查看直接或通过团队工作区与您共享的任何集合或 API 的文档。

文档作者还可以选择发布他们的文档以使其公开可用。世界上任何人都可以使用网络浏览器查看公共文档。如果关联的集合位于公共工作区中，人们还可以在 Postman 中查看该集合。

内容

• 查看集合的文档
• 查看 API 文档
• 查看公共文档
• 链接到公共文档
• 下一步

查看集合的文档

您可以查看您创建的任何集合或与您共享的集合的文档。

具有 Viewer 角色的 Postman 队友可以查看文档，而具有 Editor 角色的队友也可以创建和更新文档。了解有关角色和权限的更多信息。

要查看集合的文档：

1. 在左侧边栏中选择收藏，然后选择收藏、文件夹或请求。

   您还可以在公共 API 网络上搜索集合。

2. 在上下文栏中选择文档 以查看所选项目的文档。

3. 要查看集合的所有文档，请选择查看完整集合文档。

该文档包括对每个请求的描述，以及方法和 URL、所需的授权类型以及任何标头或参数等详细信息。对于每个请求，您可以查看各种客户端语言的示例代码，以及示例响应正文和标头。

使用以下选项自定义文档的外观：

• 发布标签：如果文档有多个发布标签，您可以选择特定的发布来查看。
• 语言：选择用于示例代码的语言。
• 代码生成设置：选择齿轮以自定义当前所选语言的设置。

查看文档的另一种方法是访问您的用户资料。选择收藏选项卡以查看已与您共享的收藏以及您自己的收藏。选择一个集合以查看其文档。

查看 API 文档

Postman 自动为API Builder 中定义的任何 OpenAPI 3.0 模式生成 API 文档。API 开发人员还可以为任何 API创建详细文档，以帮助消费者了解其 API 端点并与之交互。

要查看 API 的文档：

1. 在左侧边栏中选择API ，然后选择 API 和版本。

   您还可以在Private API Network或Public API Network上搜索API 。

2. 选择文档选项卡。

3. 在左侧窗格中选择一个文档源：

   • 架构文档：选择一个 API，然后选择一个项目以查看特定路径或请求。（模式文档仅适用于 OpenAPI 3.0 模式。）
   • 集合文档：选择一个链接集合，然后选择一个项目以查看特定路径或请求。要查看其他语言的示例代码，请在“语言”菜单中选择它。

查看公共文档

公共文档由 Postman 托管在网络上。要访问公共文档，只需在 Web 浏览器的地址栏中输入文档 URL。URL 是 Postman 在发布过程中生成的。

对于每个请求，您将看到请求的描述、方法和 URL、所需的授权类型以及任何标头或参数。您还将看到请求的示例客户端代码，以及示例响应正文和标头。

使用标题中的选项自定义文档的外观：

• 发布标签：如果文档有多个发布标签，您可以选择特定的发布来查看。
• 环境：如果环境随文档一起发布，您可以选择它来填充任何变量。
• 布局： 双列在文档右侧的列中显示示例代码。单列显示每个请求下方的示例代码内联。
• 语言：选择用于示例代码的语言。
• 语言设置：选择齿轮以自定义任何可用语言的设置。

Postman 支持用于显示示例代码的各种编程语言和框架。没有看到您选择的语言，或者是否缺少您认为有用的设置？选择齿轮，然后选择Contribute on GitHub为开源项目做出贡献。

链接到公共文档

想要与某人共享特定端点或将其加入书签以供以后使用？您可以保存指向公共文档部分的链接，包括介绍、请求、文件夹和响应。

要保存链接，请在左侧栏中选择一个部分、文件夹或请求。复制浏览器地址栏中的 URL，或将其保存为书签。下次，您可以使用 URL 直接链接到所选部分。

下一步

了解有关在 Postman 中与您的团队协作的更多信息。