Postman中文文档——示例(Examples)

示例

开发人员可以在发送实际请求或设置单个端点返回响应之前,在Postman中模拟请求和响应。在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提供其他详细信息和说明。

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

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容