最近学习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
- 对想要创建example的request,发起请求
- 请求完成后,在response面板的右上角有一个
Sava as example
按钮,点击可以保存为example
创建方式2:直接为request创建example
- 点击指定request右侧的更多图标(三个点),选择
Add example
- 输入example的name、按需要再填写请求参数、请求头、响应码(比如
200
或404
)、响应体、响应内容类型、响应头等信息 - 点击
Save
保存该example
尝试已创建的example
example创建后,会保存在对应的request下面,左侧面板可以查看
- 选择想要尝试的example
- 点击
Try
会打开新的request tab,请求会自动发送 查看请求和响应信息,这个新的request也可以保存 点击正在尝试的example的名字(此时你所处的tab是 request tab),可以在新tab中打开该example tab
编辑已有的example
直接编辑就不说了,说一下如何在尝试example后编辑它
- 选择example,点击
Try
打开新的request tab - 在新的request内更改请求信息,点击
Send
- 响应后,点击
Save as example
右侧的三个点,选择Update example
,二次确认后会更新example
版权归原作者 DragonLiOrange 所有, 如有侵权,请联系我们删除。