示例

开发人员可以在发送实际请求或设置单个端点返回响应之前，在Postman中模拟请求和响应。在API开发最早期间建立一个示例需要团队成员之间的明确沟通，使其期望达到一致，意味着开发人员和测试人员可以更快地开始使用API。

API生命周期

什么是一个示例？

什么是一个示例

一个示例是一个紧密耦合的请求和响应对。例如，在这个例子中，'200 OK custom response'是一个例子的名字，它包含一个'示例请求'和'示例响应'。

为什么使用示例？

通常情况下，创建和保存几个示例响应以及一个请求（200，404，500等的状态码）可以让您的API更容易理解。因此，查看您的API的同事可以快速查看这些示例，并了解特定请求将返回的响应 ——所有这一切，无需在请求上按“发送”。

此外，假设您将使用尚不存在的端点构建API，或者您的服务器尚未准备就绪。通过示例，您可以模拟原始响应并保存它们。然后，您可以使用Postman的模拟服务为每个客户端生成一个模拟端点。通过此设置，开发人员可以向模拟端点发出请求，并根据模拟端点返回的模拟响应开始前端开发或编写测试脚本。

添加一个示例

开始下拉菜单

假设您正在处理保存在集合中的请求，你只需要向每个API端点点击几下即可添加示例。您可以使用新建自定义响应或从服务器收到的响应为此请求添加示例。

新建自定义响应

通过让您从头开始创建自己的自定义响应，您可以通过示例来定义响应应该是什么样子。下面的图示概述了创建具有新响应的示例的步骤。

添加新的响应示例

1. 单击示例（Examples）下拉列表。
2. 单击添加示例（Add Example）按钮。基本请求作为示例编辑器中的示例请求（example request）加载。
3. 输入你的例子的名字（name）。
4. 编辑示例的请求（request）部分。
5. 输入状态码（status code）。
6. 为您的示例创建一个新的响应（response）。
7. 单击构建器右上角的保存示例（Save Example）按钮以保存示例。

从服务器收到的响应

收到服务器的响应后，您可能希望以当前请求和响应来保存为例。这样做的步骤类似于从头开始创建一个新的响应。

添加服务器响应的示例

稍后，您可以返回到您的基本请求，并在您离开的位置通过点击构建器左上角的请求名称继续下一步。

回到基本请求

访问您保存的示例

单击构建器右上角的示例（Examples）下拉列表以访问所有保存的示例。

访问保存的示例

“保存响应”功能发生了什么？

Postman具有保存响应的功能已经很长时间了。但是，我们的用户希望在保存之前编辑这些响应，并添加新的响应。示例将使所有这些变为可能！

响应可以保存到示例中。保存响应，像以前一样，但现在你可以随时编辑它们。通过单击示例（Examples）下拉菜单，访问已保存的响应。

访问保存的示例

您的示例如何在Postman文档中显示

您可能已经知道Postman已经有API文档，只需点击一下即可发布到网络上。示例将显示在您的API文档中，为您的API提供其他详细信息和说明。

您可以随时返回并编辑这些示例，并对文档进行实时更新！

文档中如何显示示例

这允许团队模拟示例请求和响应，以及使用模拟服务器模拟端点。前端和后端开发人员和测试人员都可以根据商定的示例开始并行工作。