当前位置:首页 > 让 Postman 来帮助你调试 API 接口

让 Postman 来帮助你调试 API 接口

发布于 2018-05-06 阅读 2246 次 软件

Postman 是一款可以模拟 HTTP 请求的 API 接口调试工具,是开发者不可或缺的得力助手。
有了 Postman 你会发现:原来 API 接口调试这么简单!

构造基本请求

postman请求

  1. 点击 GET 选择请求方式( GET,POST, PUT …)

  2. 地址栏输入接口请求地址:http://localhost/article

  3. 点击 Params ,下方填入相应请求参数(Key)和参数值(Value)

  4. 点击蓝色 Send 按钮发送请求

最后将会通过 GET 的方式 请求到: http://localhost/article?id=1

如果想临时取消某个参数,可以点击参数前面的勾选状态

查看请求结果响应

postman请求结果

Body

请求返回的响应内容,body 下有三栏: Pretty, Raw, Preview

  • Pretty:用来格式化美化输出显示,一般调试默认选着这个就好

  • Raw:原始数据流

  • Preview:用来展示 html / 页面

  • 数据格式:点击下拉可选择 HTML, JSON, XML, Text, Auto。这个很好理解,用来对应 API 接口数据返回类型。通常 WEB 接口开发 是用 JSON 数据类型。一般选择 JSON 就好

Cookies

切换至 Cookies 栏,可以查看当前域下所种的 Cookies 详情

postman请求结果

Headers - 当前接口返回的响应头信息

postman请求结果 - header

最后还有两个重要数据: 响应结果栏右侧的 Status,Time

  • Status:HTTP 状态码, 200 为正常
  • Time:接口响应时间

发送特殊请求

在请求参数 Key ,Value 下还有一栏特别的模块,这里就是用来处理和构造特殊请求的
postman请求结果

Authorization(接口认证)

Basic Auth

即每次接口请求携带 username, password

接口认证

填写对应 username, password 即可

其他认证模式

接口认证

这里主要讲解 Postman 使用,对于接口认证不做过多阐述,请自己选择相关认证模式对应使用

请求头(Header)

可以用来构造传递自定义的 Header 信息。比如客户端类型 client,版本 version,令牌 token …
都可以通过定义 Header 来实现

header

Cookie :如果在发送请求时想使用cookie,通过 Header 头就可添加。
不过首先需要开启 Interceptor :在顶栏右侧区域

然后我们添加一个 uid = 123 的 cookie

点击 Send 后就可以在响应结果的 Cookies 栏中看到添加的 cookie 了

请求体(Body)

在 Body 栏下可以看到四个 tab 栏,分别对应四种数据请求格式:

  • form-data
  • x-www-form-urlencoded
  • raw
  • binary

请求body

form-data

相当于在 form 表单指定 multipart/form-data 数据类型

  1. <form action="action" method="post" enctype="multipart/form-data">

通过 form-data 上传图片

上传图片

选择 file 上传对应图片/文件

x-www-form-urlencoded

相当于 form 表单,其中 Key ,Value 对应 input 表单 name,value

Raw

通过 Raw 可以构造自定义的数据格式。比如常用的 Text,Json, Xml 等。同时可以通过配合选择对应的数据类型生成对应请求头(Header)

选择数据格式

binary

二进制流,用来发送文件,视频等文件类型数据

配置环境变量(Environment)

Postman 提供了环境变量配置,在当调试接口需要在多个环境切换的时候(比如:开发,测试,预发布,线上),这个配置就可以非常方便的帮你切换环境了
首先我们点击右上角的 齿轮

选择 Manage Environments 配置文件管理 -> Add

添加 开发环境 的配置

  1. host => dev.w2le.com

同样方法,我们添加 测试,预发布环境配置

  1. # 测试
  2. host => test.w2le.com
  3. # 预发布
  4. host => staging.w2le.com

使用环境变量

通过 {{key}} 的方式可以获取我们添加的配置文件中的变量。
比如:我们在地址栏添加我们刚才添加的 host 变量 {{host}}

然后在右上角选择我们刚添加的配置

这样,我们通过切换配置项,可以让同一个接口访问到不同的环境

最后

下载 Postman