查看文档（Viewing）

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

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

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

查看集合的文档

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

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

要查看集合的文档，请执行以下操作：

1. 在边栏中选择集合，然后选择一个集合、文件夹或请求。

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

2. 选择右侧栏中的文档图标 以查看所选项目的文档。

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

如果你的集合有 gRPC 请求 或 WebSocket 请求 ，则文档图标 不可用于集合或文件夹。在边栏中选择一个收藏或文件夹以查看其描述。你无法查看包含 gRPC 或 WebSocket 请求的集合的完整集合文档。

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

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

• 版本- 如果文档有多个版本，你可以选择特定版本进行查看。（你不能再为 Postman v10 中的集合创建版本或发布，但 API 生产者可以 发布 API 的版本 。）
• 语言- 选择用于示例代码的语言。
• 代码生成设置- 选择设置图标 以自定义所选语言的设置。

查看文档的另一种方法是访问你的 用户配置文件 。选择“收藏夹”选项卡以获取已与你共享的收藏夹列表以及你自己的收藏夹。选择一个集合以查看其文档。

查看 API 文档

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

要查看 API 的文档，请执行以下操作：

1. 在边栏中选择API ，然后选择一个 API。

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

2. 在 API 的概述中选择文档来源：

   • 要查看架构文档，请在定义下选择查看架构文档。（模式文档可用于 OpenAPI 2.0 和 3.0 定义。）
   • 要查看集合文档，请展开集合并选择查看完整文档。要获取不同语言的示例代码，请在“语言”菜单中选择它。

API 开发人员可以发布不同版本的 API。你可以查看每个已发布版本的文档。详细了解如何 查看已发布的 API 版本 。

查看公共文档

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

每个请求条目都有请求的描述、方法和 URL、所需的授权类型以及任何 header 或参数。Postman 还提供请求的示例客户端代码，以及示例响应正文和 header。

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

Postman support 各种编程语言和框架 来显示示例代码。你想要使用的语言不可用吗？是否缺少你认为有用的设置？选择语言设置图标 ，然后选择Contribute on GitHub为 开源项目 做贡献。

链接到公共文档

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

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