Postman中文文档——示例（Examples）

Posted 2023-04-25

参考技术A

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Postman中文文档——同步

参考技术A

同步功能是使您的所有Postman数据都可以在您登录到Postman帐户的任何地方获得的流程。

您所做的任何更改（修改，添加，删除）将与所有与您的帐户相关联的设备同步。

以下实体将与我们的服务器同步并保存到云端：

安装Postman应用程序 ，并在所有设备上使用相同的电子邮件地址或用户名登录。如果您忘记了用户名或密码，您可以通过点击登录提示附近的链接来恢复用户名并重置密码。如果您已启用同步功能，则您现在将创建的所有数据（或过去已创建的数据）将在所有设备上同步。

Postman自动确保您的数据是一样的，无论你在哪里访问它。不需要进一步的设置。

注意 ： Postman将每个帐户的并行使用限制为3个应用程序。

如果您的应用程序与我们的服务器同步，顶部导航中您名称左侧的图标将为橙色，并显示 IN SYNC 。如果同步操作正在进行中，则会显示 同步中（SYNCING） 。如果您没有登录到应用程序，您将看到 离线（OFFLINE） 。当你打开应用程序或者你的连接被删除时，它会在连接开始同步之前显示 连接中（CONNECTING） 。

如果您选择退出，您的数据将从Postman应用的本地实例中删除。不要担心，登录时，所有的数据都将从云端中恢复。这只是为了让其他用户在没有数据冲突的情况下使用该应用程序。

当您重新加载应用程序时，Postman将自动检索最新的最新版本的集合。

如果您拥有Postman帐户，目前不是付费Postman专业版或企业团队，并且从未参加过Postman Pro试用版，您可以在此处 删除您的帐户 。否则，您可以通过 [e-mail] 与我们联系。