深入学习postman(1)-简单入门

工作中,不管是自己开发接口还是调用他人的接口,我都会先用postman调用下接口,确保接口正常可用。有一天公司老大在会议上提出要建立使用postman的规范,将调试过程中的一些数据保存下来,并且在相应的地方写上注释,当开发者的接口写完了,api接口文档也可以同步生成。由于我对postman比较熟,所以这些使用规范由我来建立。

考虑到直接用postman生成的接口文档的界面比较ugly、文档不能下载、文档资源不受自己控制且不能做版本控制、生成文档不稳定等一系列因素。我根据postman生成的数据结构开发了一套适用于公司内部使用api文档管理系统,可以根据postman的数据自动生成接口文档,对文档做版本迭代的控制,并且文档数据保存在自己的数据库中保证文档的安全。这也是我写这一系列的文章来普及postman使用方法的缘由。

一、简单介绍

postman可以使开发api更快、更方便、更简单(谷歌出品,必是精品),一般用得最多的主要功能有:

调试:测试api,检查响应结果,添加测试脚本可实现接口的鉴权。

模拟服务器:缓解开发过程中前端工程师和后端工程师的延迟

文档:快速的生成接口文档

二、下载与安装

可以通过到官网下载原生应用程序和下载chrome插件两种方式安装postman。但是postman官方已经停止对postman的chrome插件的更新,而且插件的功能远没有原生应用程序的功能强大,所以我推荐下载原生应用程序。原生应用程序支持macOS,Windows和Linux操作系统,下载地址分别如下:

Mac版本下载

windows64位版本

linux64版本下载

三、入门例子

1、发送第一个请求

现在让我们发送第一个API请求,请求地址是:

https://postman-echo.com/get?test=123

,该地址是postman提供的,大家的第一个请求也可以用该地址测试。

单击"send" 按钮发送你的请求。请注意来自服务器的JSON数据响应。

到现在为止我们的第一个请求成功了,服务器收到了我们的请求,并且将我们带过去的参数响应给了我们。

2、保存请求到收藏夹(Collections)

postman中发送的每个请求都会显示在侧栏的“历史记录”选项卡下。在小规模上,通过历史部分重用请求很方便。但是,随着接口的增加,在历史记录中查找特定请求可能会非常耗时。你可以将所有请求保存为一组收藏夹中,以便于访问,而无需梳理历史记录部分。

3、查看请求头

4、查看请求体

postman允许发送几乎任何类型的HTTP请求。根据body类型,body编辑器分为5个区域并具有不同的控制。

包括:none(none没有请求类型,这里不细讲)、form-data、x-www-form-urlencoded、raw、binary。

multipart/form-data编码

是Web表单用于传输数据的默认编码。这里是模拟在网站上填写表格并提交。表单数据编辑器允许为数据设置键值对。也可以将文件附加到键上。注意:由于HTML5规范的限制,文件不存储在历史记录或集合中。下次发送请求时,需要再次选择该文件。目前尚不支持上传多个文件,每个文件都有自己的Content-Type。

urlencoded编码

此编码与URL参数中使用的编码相同。只需输入键值对,postman将正确编码键和值。请注意,无法通过该编码模式上传文件。和urlencoded之间可能存在一些混淆,因此请务必先检查你的API。

raw编码

原始请求可以包含任何内容。postman不会解析在原始编辑框中输入的字符串。无论你在文本区域放置什么,都会随请求一起发送。

binary编码

二进制数据编码允许你发送无法在postman中输入的内容,例如图像,音频或视频文件。你也可以发送文本文件。如前面在表单数据部分中所提到的,如果要通过历史记录或集合加载请求,则必须重新附加文件。

postman基本入门写得差不多了,但是这系列的文章还没写完,下一篇文章会深入讲解postman的一些高级特性。

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20181217G1KJW900?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 yunjia_community@tencent.com 删除。

扫码关注云+社区

领取腾讯云代金券