示例展示了您的 API 端点的实际运行情况，并提供了有关请求和响应具体如何工作的更多详细信息。您只需保存响应即可快速将示例添加到请求中，或者使用自定义响应创建示例以说明特定用例。创建示例后，您可以使用它们来设置模拟服务器或向 API 文档添加更多详细信息。

什么是例子？

在 Postman 中，一个例子是紧耦合的请求和响应对。每个示例都由请求部分（方法、URL、参数、标头和正文）和响应部分（状态代码、正文和标头）组成。您可以通过将示例添加到集合中的请求来创建示例，并且一个请求可以有多个示例。

为一个请求提供多个示例有助于说明端点响应请求的不同方式。您可能有响应不同状态代码（例如 200 或 404）或返回不同数据（或根本没有数据）的示例。

示例在几个方面很有用。开发人员和测试人员可以参考示例，以更好地了解端点在不同场景中的功能。示例还可用于设置模拟服务器，因此开发人员和测试人员可以开始针对您的 API编写代码——甚至在它完成之前。此外，您可以在 API 的公共文档中包含示例，以帮助世界上使用您的 API 的任何人。

添加示例

一个示例总是与集合中的一个请求相关联，一个请求可以有多个示例。要快速向请求添加示例，请发送请求，然后将响应保存为示例。您还可以手动向请求添加示例并定义自定义响应。使用任一方法添加示例后，您可以随时对其进行编辑以进行更改。

为确保 Postman 应用程序的最佳性能，示例响应的大小不应超过 5 MB。

保存响应作为示例

在 Postman 中保存回复时，您可以选择将其保存为示例。

1 在边栏中选择收藏。

2 打开一个请求并选择发送。

3 在响应窗格中，选择保存响应，然后选择另存为示例。

添加自定义示例

通过自定义示例，您可以准确定义请求和响应的外观，包括状态代码和响应正文。

1 在边栏中选择收藏。

2 三个点图标选择请求旁边的三个点，然后选择添加示例。

3 输入示例的名称。

4 编辑示例的请求部分。

• 根据需要添加任何参数或标题。

• 输入请求正文并选择内容类型。

5 编辑示例的响应部分。

• 输入状态码（例如 200 或 404）。

• 输入响应正文并选择内容类型。

• 根据需要添加任何标题。

选择保存以保存示例。

编辑示例

示例存储在其关联请求下方的集合中。添加示例后，您可以随时编辑示例以删除敏感令牌、更改状态代码或进行任何其他调整。

1 在边栏中选择收藏。

2 选择一个请求，然后选择一个示例将其打开。

3 对示例请求或响应进行任何更改。

4 选择保存以保存示例。

复制一个例子

复制示例以使用现有示例作为基础快速添加新示例。然后，您可以编辑复制的示例以更改名称、状态代码或请求或响应的任何其他部分。

1 在边栏中选择收藏。

2 选择示例旁边的三个点三个点图标，然后选择复制。

3 对示例请求或响应进行任何更改。

4 选择保存以保存示例。

删除示例

删除示例会将其从集合以及相关 API 文档中删除。您设置的任何模拟服务器都不能再使用该示例返回响应。

1 在边栏中选择收藏。

2 选择示例旁边的三个点三个点图标，然后选择Delete。

3 选择删除以确认。

在文档中使用示例

Postman 会自动为您创建的每个集合生成文档。生成的文档包括已添加到集合中的任何示例。如果您编辑示例，文档会自动更新您的更改。

示例为您的 API 提供更多详细信息和说明，并帮助您的团队在 API 开发上进行协作。前端开发人员、后端开发人员和测试人员都可以并行工作，使用文档中的示例作为指导或设置模拟服务器。

您可以发布您的文档，让世界上的任何人都可以公开您的示例。

下一步

使用示例设置模拟服务器或在您的API 文档中包含示例。