使用Postman管理API接口

为了使服务端开发的API接口管理正规化流程化,因此,使用Postman这款神器来管理咱们的接口,以方便后续项目的迭代开发。php

1、什么是Postman

Postman最基础的功能就是发送http请求,支持GET/PUT/POST/DELETE,还有不少其余的http方法。个人理解就是能够经过这一款神器,达到模拟浏览器提交各类API请求,好比咱们最经常使用的是和APP端的协做开发,服务端开发好API接口后,APP端同事须要调用咱们的接口,每每咱们服务端管理许多接口,若是须要对某一个接口进行测试,都是在服务端对相关接口的方法进行调试,若是没有问题,则直接给APP端,这样虽然操做起来比较简单,可是不太效,有时咱们也用curl模拟进行请求,看接口是否正常,可是这样也比较慢,不直观,若是牵扯到权限验证access_token,则又会比较麻烦,因此,这里强烈推荐使用Postman这款比较强大的模拟请求工具来进行接口管理。laravel

2、使用

咱们使用laravel-china.org提供的PHPHub开源项目的API来对Postman进行练手,因此,在这里要感谢他们的开源共享精神!git

1.具体步骤

1.下载 Postman

2.导入 接口信息文件

clipboard.png

3.导入 环境设置文件

点击设置标识,而后进入管理环境
clipboard.pnggithub

将该连接的json文件下载到本地,而后导入:
clipboard.pngjson

咱们能够看一下咱们导入的环境:segmentfault

clipboard.png

导入的这些参数,在待会请求时会是环境中全局的参数,这样就能够避免每次请求时须要给接口添加特定参数的麻烦了,如url为接口域名,在使用时咱们只须要这样封装https://{{url}}/users/me便可,还有若是请求用户的时候,须要用户权限的验证,如咱们在拿到受权后,能够将该Token添加到环境变量中,这时若是后边须要,便可经过变量拿到,因此很是方便。api

2. 示例

让咱们切换到PHPHub API Staging环境下,而后经过POST 提交{{url}}/oauth/access_token获取客户端的access_token浏览器

clipboard.png

咱们须要从上面的请求结果中获取到用户Token,并将这个值保存到环境变量中,以供后续使用。将下面这段代码添加到测试编辑器中:cookie

var data = JSON.parse(responseBody);

if (data.access_token) {
  tests["Body has access_token"] = true;
  postman.setEnvironmentVariable("access_token", data.access_token);
}
else {
  tests["Body has access_token"] = false;
}

clipboard.png

最后获取登录的Token,即为password_token也加入到环境变量中session

clipboard.png

该phpHub开放的API接口参数说明:

clipboard.png

若是为通常APP端请求,则须要传递client_token,才能获取通常的信息,如文章信息,回复信息等,若是须要发表文章,则须要用户登录受权,既拿到password_token才能够进行须要权限的操做,由于APP端没有session,cookie,因此,只能经过各类Token来从服务端获取受权进行相关的操做。
参考博文:

PHPHub Staging API 已开放
基于Postman的API自动化测试

相关文章
相关标签/搜索