- 安装与更新
- 发送第一个请求
- 创建第一个集合（collections）
- 界面布局
- 帐号
- 同步
- 设置
- 请求（Request）
- 响应（Response）
- 历史记录（History）
- API 请求疑难解答
- 调试和日志
- 授权（Authorization）
- Cookies
- 证书（Certificates）
- 捕获 HTTP 请求（Capturing HTTP requests）
- Interceptor 扩展
- 生成代码段（Generate code snippets）
- 发出 SOAP 请求
- 创建集合（Creating collections）
- 分享集合（Sharing collections）
- 管理集合（Managing collections）
- 使用 Markdown 添加描述
- 示例（Examples）
- 数据格式
- 脚本简介
- 预请求脚本（Pre-request scripts）
- 测试脚本
- 测试示例（Test examples）
- 分支和循环（Branching and looping）
- 沙盒（Sandbox）
- 变量（Variables）
- 管理环境（Manage environments）
- 管理全局变量（Manage globals）
- 开始运行一个集合
- 在集合运行器中使用环境
- 使用数据文件（Working with data files）
- 运行多次迭代（Running multiple iterations）
- 构建工作流程（Building workflows）
- 共享集合运行（Sharing a collection run）
- 调试集合运行（Debugging a collection run）
- 与 Newman 集成
- 与 Jenkins 集成
示例（Examples）
示例
开发人员可以在发送实际请求或设置单个端点返回响应之前，在 Postman 中模拟请求和响应。在 API 开发最早期间建立一个 示例 需要团队成员之间的明确沟通，使其期望达到一致，意味着开发人员和测试人员可以更快地开始使用 API。
什么是一个示例？
一个示例是一个紧密耦合的请求和响应对。例如，在这个例子中，'200 OK custom response'是一个例子的名字，它包含一个'示例请求'和'示例响应'。
为什么使用示例？
通常情况下，创建和保存几个示例响应以及一个请求（200，404，500 等的状态码）可以让您的 API 更容易理解。因此，查看您的 API 的同事可以快速查看这些示例，并了解特定请求将返回的响应 - 所有这一切，无需在请求上按“发送”。
此外，假设您将使用尚不存在的端点构建 API，或者您的服务器尚未准备就绪。通过示例，您可以模拟原始响应并保存它们。然后，您可以使用 Postman 的模拟服务 为每个客户端生成一个模拟端点。通过此设置，开发人员可以向模拟端点发出请求，并根据模拟端点返回的模拟响应开始前端开发或 编写测试脚本 。
添加一个示例
假设您正在处理保存在 集合中 的请求，你只需要向每个 API 端点点击几下即可添加示例。您可以使用 新建自定义响应 或 从服务器收到的响应 为此请求添加示例。
新建自定义响应
通过让您从头开始创建自己的自定义响应，您可以通过示例来定义响应应该是什么样子。下面的图示概述了创建具有新响应的示例的步骤。
- 单击 示例 （ Examples ）下拉列表。
- 单击 添加示例 （ Add Example ）按钮。基本请求作为示例编辑器中的 示例请求 （ example request ）加载。
- 输入你的例子的 名字 （ name ）。
- 编辑示例的 请求 （ request ）部分。
- 输入 状态码 （ status code ）。
- 为您的示例创建一个新的 响应 （ response ）。
- 单击构建器右上角的 保存示例 （ Save Example ）按钮以保存示例。
从服务器收到的响应
收到服务器的响应后，您可能希望以当前请求和响应来保存为例。这样做的步骤类似于从头开始创建一个新的响应。
添加服务器响应的示例稍后，您可以返回到您的基本请求，并在您离开的位置通过点击构建器左上角的请求名称继续下一步。
访问您保存的示例
单击构建器右上角的 示例 （ Examples ）下拉列表以访问所有保存的示例。
“保存响应”功能发生了什么？
Postman 具有 保存响应 的功能已经很长时间了。但是，我们的用户希望在保存之前编辑这些响应，并添加新的响应。示例将使所有这些变为可能！
响应可以保存到示例中。保存响应，像以前一样，但现在你可以随时编辑它们。通过单击 示例 （ Examples ）下拉菜单，访问已保存的响应。
您的示例如何在 Postman 文档中显示
您可能已经知道 Postman 已经有 API 文档 ，只需点击一下即可发布到网络上。示例将显示在您的 API 文档中，为您的 API 提供其他详细信息和说明。
您可以随时返回并编辑这些示例，并对文档进行实时更新！
这允许团队模拟示例请求和响应，以及使用 模拟服务器 模拟端点。前端和后端开发人员和测试人员都可以根据商定的示例开始并行工作。
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论