postman 为request创建example

最近学习postman,苦于国内找不到相关的文档(找到了也是老版的postman,UI都不一样了,照着教程也摸不着头脑),于是啃啃生肉翻译了一下官方文档
原文:Create examples of request responses to illustrate API use cases,翻译了部分内容,但是像request,example这些postman中的名词就没有必要翻译了吧~

原文中的名词,需要简单了解的概念
  • endpoint端点:可以理解为一个url,但不包括参数
  • request请求:包含url、请求方法、请求头、参数
  • example示例/用例:request的具体例子,一个request可以对应多个example,url相同,参数和response可能不同。侧重请求和响应的关系。
  • api use case:侧重描述api的实际使用场景,可能包含多个example

什么是examples

example用于说明接口的具体信息,在postman中,一个example是一对request和response的搭配,每个example都有request部分(请求方法、url、请求体、请求头、参数)和response部分(响应码、响应头、响应体)。
给request编写多个examples能帮助说明这个接口怎么响应请求的(比如不同情况下有的响应码、不同的响应数据)
开发和测试能参照example来更好地理解接口在不同情况下的功能;example还能用来设置mock servers,这样即使相关模块没有开发完成也能进行测试;postman中还会把example自动加入接口文档

添加example的方式

example是和request关联的,一个request可以有多个example。postman中有两种给request添加对应example的方式,一种是发起request后把结果保存为example(会自动记录这次请求的params和response),另一种是直接向request添加example(需要自己手动输入该params下预期的response)

为了postman的最佳性能,example的response必须小于5MB
原文:For optimal Postman performance, example responses must be smaller than 5 MB.

创建方式1:发起请求后,将response保存为example
  1. 对想要创建example的request,发起请求
  2. 请求完成后,在response面板的右上角有一个Sava as example按钮,点击可以保存为example
创建方式2:直接为request创建example
  1. 点击指定request右侧的更多图标(三个点),选择Add example
    在这里插入图片描述
  2. 输入example的name、按需要再填写请求参数、请求头、响应码(比如200404)、响应体、响应内容类型、响应头等信息
  3. 点击Save保存该example
尝试已创建的example

example创建后,会保存在对应的request下面,左侧面板可以查看

  1. 选择想要尝试的example
  2. 点击Try会打开新的request tab,请求会自动发送在这里插入图片描述
    查看请求和响应信息,这个新的request也可以保存

    点击正在尝试的example的名字(此时你所处的tab是 request tab),可以在新tab中打开该example tab
    在这里插入图片描述
编辑已有的example

直接编辑就不说了,说一下如何在尝试example后编辑它

  1. 选择example,点击Try打开新的request tab
  2. 在新的request内更改请求信息,点击Send
  3. 响应后,点击Save as example右侧的三个点,选择Update example,二次确认后会更新example
    在这里插入图片描述
  • 12
    点赞
  • 15
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Postman中使用Pre-request Script发送前置请求的步骤如下: 1. 打开Postman,选择一个请求,在请求的“Pre-request Script”标签下编写JavaScript代码。 2. 在Pre-request Script中使用`pm.sendRequest()`方法发送前置请求,将响应结果保存到环境变量或全局变量中。 3. 在测试请求中使用环境变量或全局变量,即可获取前置请求的结果。 下面是一个示例: 假设我们有一个API `/users`,需要在请求之前先获取所有用户的ID,然后再根据ID获取用户的详细信息。我们可以使用Pre-request Script发送前置请求,获取用户ID,并将其保存到环境变量中。然后在测试请求中,使用环境变量来获取用户详细信息。 Pre-request Script: ``` pm.sendRequest({url: 'https://example.com/api/users', method: 'GET'}, function (err, res) { if (err) { console.log(err); } else { var userIds = JSON.parse(res.body).map(function(user) { return user.id; }); pm.environment.set('userIds', userIds); } }); ``` 这个例子中,我们发送了一个GET请求到`https://example.com/api/users`,获取所有用户的信息。然后将每个用户的ID保存到一个数组中,并将这个数组保存到了环境变量`userIds`中。 测试请求: ``` // 获取第一个用户的详细信息 var userId = pm.environment.get('userIds')[0]; pm.sendRequest({url: 'https://example.com/api/users/' + userId, method: 'GET'}, function (err, res) { if (err) { console.log(err); } else { console.log(res.body); } }); ``` 这个例子中,我们从环境变量`userIds`中获取第一个用户的ID,并使用这个ID发送了一个GET请求到`https://example.com/api/users/:id`,获取该用户的详细信息。最后将响应结果打印到了控制台中。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值