Postman简介
一般简单的接口测试我们可以直接在浏览器里面进行调试,但是涉及到一些权限设置的就无法操作了,因此我们需要接口测试的相关工具;Postman 是一个接口测试和 http 请求的工具。
官网地址:https://www.getpostman.com
Postman 的优点:
- 支持各种的请求类型: get、post、put、patch、delete 等
- 支持在线存储数据,通过账号就可以进行迁移数据
- 很方便的支持请求 header 和请求参数的设置
- 支持不同的认证机制,包括 Basic Auth,Digest Auth,OAuth 1.0,OAuth 2.0 等
-
响应数据是自动按照语法格式高亮的,包括 HTML,JSON 和 XML
下载安装
Postman有windows,Mac、Liunx以及Chrome插件版本。这里主要介绍Win平台版本的使用。
- 官方文档:https://www.getpostman.com/docs/v6/
- Postman Api文档:https://docs.postman-echo.com
Postman 入门
安装好之后启动程序,进入主界面。准备开始使用Postman.
发送第一个请求
-
启动软件后在引导界面点击Request,给Request命名,然后创建文件夹并把该Request归属到该文件夹。
-
在地址栏输入
postman-echo.com/get
然后点击 Send按钮,可以看到返回值。如下图所示:
Postman工作原理
如下图所示,当您在Postman中输入请求并单击Send按钮时,服务器将接收您的请求并返回Postman在接口中显示的响应。
Request编辑
在主界面左侧可以查看、保存、编辑Request。
发送不同类型HTTP请求
GET
HTTP GET请求方法用于从服务器检索数据。
数据由唯一的URI(统一资源标识符)标识。
GET请求可以使用“Query String Parameters”将参数传递给服务器。
例如,在下面的请求中,
|
|
请求说明
- param1和param2表示发送的参数。
?
后面接参数&
连接多个参数
参数编辑
- 点击Params按钮,Postman 可以自动帮我们解析出对应参数。
- 如果想要暂时不传参数,可以方便的通过不勾选的方式去实现
- 如果想要批量的编辑参数,可以点击右上角的Bulk Edit,去实现批量编辑
响应数据
在主界面下方一栏菜单为响应菜单栏,可以查看响应内容,Cookie、Headers、响应状态码等信息。
返回值:
|
|
POST
HTTP POST请求方法旨在将数据传输到服务器,返回的数据取决于服务器的实现。
POST请求可以使用Query String Parameters
以及body
将参数传递给服务器。
案例1
在下面的请求中,使用Query String Parameters
传递参数。
|
|
返回值
|
|
案例2
发送一个Request,其中body为application/x-www-form-urlencoded
类型,参数分别为param1=zxw
和param2=888
请求URL如下:
|
|
Postman Body数据类型说明:
-
form-data
multipart/form-data
是Web表单用于传输数据的默认编码。这模拟了在网站上填写表单并提交它。表单数据编辑器允许我们为数据设置键-值对。我们也可以为文件设置一个键,文件本身作为值进行设置。 -
x-www-form-urlencoded 该编码与URL参数中使用的编码相同。我们只需输入键-值对,Postman会正确编码键和值。请注意,我们无法通过此编码模式上传文件。表单数据和urlencoded之间可能存在一些差异,因此请务必首先检查API的编码实现,确定是否可以使用这种方式发送请求。
-
raw 请求可以包含任何内容。除了替换环境变量之外,Postman不触碰在编辑器中输入的字符串。无论你在编辑区输入什么内容,都会随请求一起发送到服务器。编辑器允许我们设置格式类型以及使用原始主体发送的正确请求头。我们也可以手动设置
Content-Type
标题,这将覆盖Postman定义的设置。 -
binary 二进制数据可让我们发送Postman中无法输入的内容,例如图像,音频或视频文件。
返回值如下:
|
|
PUT
HTTP PUT请求主要是从客户端向服务器传送的数据取代指定的文档的内容。
PUT请求可以使用Query String Parameters
以及body
请求体将参数传递给服务器。
案例:
发送PUT请求,并传递字符参数“hello 51zxw”
|
|
返回值
|
|
DELETE
HTTP DELETE方法用于删除服务器上的资源,DELETE请求可以使用Query String Parameters
以及body
请求体将参数传递给服务器。
delete请求
|
|
返回值
|
|
Request Header
Request Header(请求头)用来说明服务器要使用的附加信息,比较重要的信息有 Cookie、Referer、User-Agent 等。在Postman中可以在请求下方的Headers栏目来设置,如下如图所示:
Response Header
Response Header(响应头)其中包含了服务器对请求的应答信息,如 Content-Type、Server、Set-Cookie 等,在Postman主界面下方Headers或者Postman Console界面都可以查看Response Header信息。
Tips:通过Postman Console可以看到每次请求的Request Header详细信息,详见视频演示。
授权设置
很多时候,出于安全考虑我们的接口并不希望对外公开。这个时候就需要使用授权(Authorization)机制
授权过程验证您是否具有访问服务器所需数据的权限。
当您发送请求时,您通常必须包含参数,以确保请求具有访问和返回所需数据的权限。
Postman提供授权类型,可以轻松地在Postman本地应用程序中处理身份验证协议。
Postman支持的授权协议类型如下:
- No Auth
- Bearer Token
- Basic auth
- Digest Auth
- OAuth 1.0
- OAuth 2.0
- Hawk Authentication
- AWS Signature
- NTLM Authentication [Beta]
这里主要介绍以上加粗的授权协议的使用。
Basic auth
基本身份验证是一种比较简单的授权类型,需要经过验证的用户名和密码才能访问数据资源。这就需要我们输入用户名和对应的密码。
案例:请求URL如下,授权账号为:
- 用户名:
postman
- 密码:
password
- 授权协议为:
Basic auth
|
|
-
如果不输入用户名密码,直接使用GET请求,则会返回提示:Unauthorized
-
输入用户名密码,选择Basic auth授权类型,则返回如下结果:
|
|
Digest Auth
Digest auth 是一个简单的认证机制,最初是为HTTP协议开发的,因此也常叫做HTTP摘要。其身份验证机制非常简单,它采用哈希加密方法,以避免用明文传输用户的口令。摘要认证就是要核实參与通信的两方都知道双方共享的一个口令。
当server想要查证用户的身份,它产生一个摘要盘问(digest challenge),并发送给用户。典型的摘要盘问例如以下:
|
|
这里包含了一组参数,也要发送给用户。用户使用这些參数,来产生正确的摘要回答,并发送给server。摘要盘问中的各个參数,其意义例如以下:
realm(领域):领域參数是强制的,在全部的盘问中都必须有。它是目的是鉴别SIP消息中的机密。在SIP实际应用中,它通常设置为SIP代理server所负责的域名。
nonce(现时):这是由server规定的数据字符串,在server每次产生一个摘要盘问时,这个參数都是不一样的(与前面所产生的不会雷同)。“现时”一般是由一些数据通过md5杂凑运算构造的。
这种数据通常包含时间标识和server的机密短语。这确保每一个“现时”都有一个有限的生命期(也就是过了一些时间后会失效,并且以后再也不会使用),并且是独一无二的
(即不论什么其他的server都不能产生一个同样的“现时”)。
algorithm(算法):这是用来计算的算法。当前仅仅支持MD5算法。
qop(保护的质量)。这个參数规定server支持哪种保护方案。client能够从列表中选择一个。值auth
表示仅仅进行身份查验, auth-int
表示进行查验外,另一些完整性保护。须要看更具体的描写叙述,请參阅RFC2617。
案例
请求URL如下
|
|
摘牌配置信息如下:用户名密码和上面basic auth一样
|
|
执行请求结果如下:
|
|
Hawk Auth
Hawk Auth是一个HTTP认证方案,使用MAC(Message Authentication Code,消息认证码算法)算法,它提供了对请求进行部分加密验证的认证HTTP请求的方法。hawk方案要求提供一个共享对称密匙在服务器与客户端之间,通常这个共享的凭证在初始TLS(安全传输层协议)保护阶段建立的,或者是从客户端和服务器都可用的其他一些共享机密信息中获得的。
案例
请求URL如下:
|
|
密钥信息如下:
-
Hawk Auth ID: dh37fgj492je
-
Hawk Auth Key: werxhqb98rpaxn39848xrunpaw3489ruxnpa98w4rxn
-
Algorithm: sha256
执行结果:
|
|
如果将key改为其他任意的字符则返回如下结果:
|
|
OAuth 1.0
OAuth(开放授权)是一个开放标准,允许用户让第三方应用访问该用户在某一网站上存储的私密的资源(如照片,视频,联系人列表),而无需将用户名和密码提供给第三方应用。
扩展资料:
案例
请求URL如下:请求方式为GET,Add authorization data to
设置为:Request Headers
|
|
参数配置为:
- Consumer Key: RKCGzna7bv9YD57c
- Consumer Secret: D+EdQ-gs$-%@2Nu7
发送请求结果如下:
|
|
如果Consumer Secret错误则返回如下结果:
|
|
扩展资料:各个授权协议文档
Cookie设置
cookie是存储在浏览器中的小片段信息,每次请求后都将其发送回服务器,以便在请求之间存储有用的信息。比如很多网站登录界面都有保留账号密码,以便下次登录。
由于HTTP是一种无状态的协议,服务器单从网络连接上无从知道客户身份。怎么办呢?就给客户端们颁发一个通行证吧,每人一个,无论谁访问都必须携带自己通行证。这样服务器就能从通行证上确认客户身份了。这就是Cookie的工作原理。
Cookie是由服务端生成,存储在响应头中,返回给客户端,客户端会将cookie存储下来,在客户端发送请求时,user-agent会自动获取本地存储的cookie,将cookie信息存储在请求头中,并发送给服务端。postman也可以设置、获取、删除Cookie。
Set Cookies
在Send按钮下方点击Cookies
文字菜单,弹出如下界面,然后可以设置Cookie。
请求URL如下:请求方式为GET,添加Cookie值为username:51zxw
|
|
打开Console找到Request Header可以看到自定义设置的Cookie内容。
Get Cookies
Cookie获取比较简单,直接获取Response Headers里面的set-cookie值即可,或者在主界面下方Cookie菜单栏里面也可以查看。
Delete Cookies
点击Cookies
文字菜单,然后可以根据需求去清除对应的Cookie。
变量
问题思考
在开发不同阶段可能存在不同的环境,比如测试环境和生产环境。
测试环境API如下:
|
|
生产环境API如下:
|
|
在这么情况下,按照常规思路要么你需要维护两套环境的API,要么每次都手动一个个去修改URL,不管哪种选择都比较麻烦且低效,那么有没有比较的好的方法来解决这个问题呢?
Postman变量类型
通过比较我们可以发现,以上两组API主要是除了host不同之外其他都一样,其实把Host用变量替换,这样就可以灵活切换环境。
Postman提供了变量设置,有4种变量类型。
- 本地变量(LocalVariable )
- 全局变量(Global Variable)
- 环境变量(Environment Variable)
- 数据变量(Data Variable)
环境变量
环境变量指在不同环境,同一个变量值随着环境不同而变化,比如我们上面举例场景就可以使用环境变量,当在测试环境时,host值为: dev.postman.com ,当切换到生产环境时,host值变为:postman-echo.com 。
环境变量设置:
在postman界面点击右上角眼睛图标,即可开始设置环境变量和全局变量。环境变量设置过程如下图所示:我们可以设置两种环境 dev
和release
,dev
是开发测试环境; release
是正式的生产环境。host
环境变量,根据不同的环境值不一样。
变量引用格式为,如下图所示:
详细过程见视频演示。
本地变量
本地变量主要是针对单个URL请求设置的变量,作用域只是局限在请求范围内。如请求URL如下,设置两个本地变量(user,passwd)作为参数。请求方式为POST
|
|
从上图中我们可以看到变量设置的格式为
变量设置好之后需要赋值,在Pre-request-Script
里面编写如下代码:
|
|
点击send执行之后的返回值如下,可以看到我们定义的变量已经发送。
|
|
全局变量
全局变量是指在所有的环境里面,变量值都是一样的,全局变量的作用域是所有请求。
全局变量设置有两种方式:
- 点击界面里设置
- 在脚本里设置
界面设置
点击眼睛图标后,在Global
选项菜单点击Edit
菜单即可设置全局变量,如下图所示。全局变量的引用格式和环境变量一样,
注意:当环境变量和全局变量名称一样时,切换到某个环境时,环境变量会覆盖全局变量。
脚本设置
使用如下脚本可以设置全局变量:variable_key
表示变量名称, variable_value
表示变量值。
|
|
实践案例
在实际接口测试过程中,接口经常会有关联。比如需要取上一个接口的某个返回值,然后作为参数传递到下一个接口作为参数。假设我们要获取A接口返回的userid
值作为B接口的请求参数。
A接口请求URL如下:
|
|
- 请求方式为Post
- 请求参数:userid(这里自己定义,接口会返回对应的id值)
返回值
|
|
根据返回值我们需要从返回值中提取userid值。在Test
标签栏下编写如下脚本获取userid
值
|
|
B接口请求URL如下:请求方式为GET
|
|
先执行A接口的,然后在执行B接口,此时B接口通过全局变量userid
可以获得A接口的返回值。
数据变量
数据变量是通过导入外部数据文件(json文件或者csv文件),来获取变量数据。我们可以创建一个如下内容的json文件:
data.json
|
|
稍后我们会结合运行Collection来讲解如何导入该数据文件。
断言
简介
一般来说执行完测试,我们需要对测试结果来进行校验,判断结果是是否符合我们的预期,也就是断言。在接口测试中一般会根据响应状态码或者响应返回的数据来进行断言。
Postman提供一个测试沙箱(Postman Sandbox) 测试沙箱是一个JavaScript执行环境,可以通过JS脚本来编写pre-request Script和test Script。
- pre-request Script(预置脚本)可以用来修改一些默认参数,在请求发送之前执行。有点类似于unittest里面的setUp()方法。
- test Script(测试脚本)当接收到响应之后,再执行测试脚本。
案例
接口请求URL如下:请求方式为POST
|
|
断言规则
- 响应状态码:200
- 响应内容:返回的
user
参数值与定义的一致 - 响应时间:小于0.5s
测试脚本
在pre-request Script
定义变量user
|
|
在Test
栏下面编写如下脚本
|
|
断言结果
扩展资料:Postman测试脚本官方文档
运行Collection
批量执行
当我们想批量测试某个集合里面的各个API时,可以使用Collection Runner来批量运行API,同时可以进行环境变量、迭代执行次数、延迟时间等设置。
执行结果
数据驱动
应用背景
有时我们针对一个接口需要测试很多不同的参数,如果每次一个个的去修改参数值来进行测试这样效率肯定会比较低下。因此我们需要每次迭代执行传入不同的参数进行测试,那么需要导入外部数据文件进行参数化,也就是所谓的数据驱动。
数据导入
如下图所示,data选择之前我们创建的json数据文件:data.json,文件类型选择application/json
json数据内容如下:
|
|
请求之前延迟时间最好设置为1000~3000,避免过于频繁请求被禁。
点击Preview
按钮可以预览导入的数据。
执行结果
构建工作流
问题思考
在使用“Collection Runner”的时候,集合中的请求执行顺序就是请求在Collection中的显示排列顺序。但是,有的时候我们不希望请求按照这样的方式去执行,可能是执行完第一个请求,再去执行第五个请求,然后再去执行第二个请求这样的方式;那么在“Collection Runner”中如何去构建不同的执行顺序呢?
设置方法
最直接的方法就是直接在集合里面拖动调整顺序,但是每次去拖动也比较麻烦,特别是当请求比较多的时候。这个时候最高效的方法就是通过脚本设置。
首先下载官方提供的案例文件:collection.json 导入到postman,运行Collection结果如下图所示:
接下来要调整执行顺序为:Request1->Request3->Request2->Request4
首先在第一个请求:Request1中Test
添加如下代码:表示下一个请求为执行请求名称为Request3
的请求
|
|
然后在Request3的请求中Test
添加如下代码:表示下一个请求为执行请求名称为Request2
的请求
|
|
最后在Request2的请求中Test
添加如下代码:表示下一个请求为执行请求名称为Request4
的请求.
|
|
注意:第一个执行请求的排序一定要在第一个。
执行结果
相关资料:collection runs官方文档
命令执行
问题思考
在前面我们都是在postman图形界面工具里面进行测试,但是有时候我们需要把测试脚本集成到CI平台,或者在非图形界面的系统环境下测试,那么该如何处理呢?
Newman简介
Newman是一款基于Node.js开发的可以运行Postman的工具,使用Newman,可以直接从命令行运行和测试Postman集合。
Newman应用
环境准备
- Node.js
- cnpm或npm
配置好环境后,执行如下命令安装newman
|
|
输入如下面命令检测安装是否成功
|
|
执行测试
首先将postman的集合导出,如下图所示:
在桌面新建文件夹pmtest
,将导出的postman文件和相关数据文件放入。
打开cmd进入到pmtest
目录,输入如下命令:
|
|
命令说明
run
代表要执行的postman脚本,即为导出的集合。-d
表示要执行的数据,也就是之前导入postman的数据-r
生成的测试报告类型,这里生成html格式报告
更多命令用法请输入newman -h
即可查看。
报告查看
在测试文件夹pmtest
里面可以看到生成的一个newman
文件夹,打开就可以看到生成的测试报告。
Html报告样式:newman-run-report
newman不仅支持生成html报告,还支持其他报告类型:
- JSON reporter
- JUNIT/XML reporter
- Client report
- Html report
集成Jenkins
Jenkins简介
Jenkins是一个开源软件项目,是基于Java开发的一种持续集成工具,用于监控持续重复的工作,旨在提供一个开放易用的软件平台,使软件的持续集成变成可能。
下载与安装
下载地址:https://jenkins.io/download/
下载后安装到指定的路径即可,默认启动页面为localhots:8080
,如果8080
端口被占用无法打开,可以进入到jenkins安装目录,找到jenkins.xml
配置文件打开,修改如下代码的端口号即可。
|
|
集成步骤
集成到jenkins的思路其实很简单,就把之前我们执行测试的cmd命令放到jenkins里面去执行。集成步骤也很简单:
- 首先新建一个项目:
postman_api_test
- 然后在构建栏目下拉菜单选择
Execute Windows batch command
|
|
Tips:我的jenkins安装在D盘因此需要使用命令 c:
切换到postman脚本所在盘符。
最后执行结果如下:
导出不同语言脚本
问题思考
虽然Postman功能比较强大,但是毕竟是一款商业工具,多少会有一些限制。比如只支持js脚本运行,如果我们想用自己熟悉的编程语言(如:Python,java等)来做接口自动化测试该如何处理?
操作步骤
Postman支持导出不同语言版本的脚本,当一个接口调试好之后,点击右侧的code
字样即弹出如下界面可以选择语言。最后选择你需要语言版本即可生成对应的代码。
生成的代码片段可以点击 Copy to Clipboard
复制。
参考资料
- https://docs.postman-echo.com/#1eb1cf9d-2be7-4060-f554-73cd13940174
- https://www.jellythink.com/archives/169
- https://blog.csdn.net/wangyuquanliuli/article/details/24850761
- https://www.cnblogs.com/happy-today/p/7928822.html
- http://www.mamicode.com/info-detail-1693734.html
- https://blog.csdn.net/qq_14908027/article/details/77923792
本博客为转载博客,转载地址:https://sutune.me/2018/07/12/postman/
来源:oschina
链接:https://my.oschina.net/u/4280276/blog/3676913