高效地重建API文档
当你接手一个缺乏管理的项目时,项目的API可能已开发完成,但却由于没有API文档,使得维护工作变得异常艰难。
通过Postman的内置proxy(代理)和interceptor(拦截器),我们可以快速地为现有项目在Postman中重建API文档。
重建API文档分为2个部分:首先我们需要通过Postman的内置代理或者拦截器捕获所有请求,之后再为这些请求添加必要的内容来完善API文档。
捕获请求
使用内置代理捕获请求
通过Postman的内置代理来捕获请求,需要执行以下步骤:
1.首先确保目标设备与运行Postman的计算机处于同一网络,之后设置代理端口,并将Capture Requests选项切换为启用。
(代理设置)
2.然后为目标设备设置网络代理,代理服务器需要填写运行Postman的计算机的IP地址,之后只要目标设备发起了网络请求,我们便能在Postman中查看并保存这些请求。
(代理设置)
(捕获的请求)
使用拦截器捕获请求
使用Postman的拦截器需要安装对应的Chrome扩展:Postman Interceptor。
(Postman Interceptor)
安装后之后,点击Postman Interceptor扩展的图标,在设置页面将Capture Requests选项设置为启用即可。当其状态显示为CONNECTED,则表明拦截器正在工作中。
(工作中的拦截器)
完善API文档
为了排除无用的请求,我们可以通过设置Host(主机)来捕获特定的请求,或者在捕获请求后使用过滤器来对请求进行筛选。
之后,我们在Postman中重新发起这些请求,并为其添加描述信息、参数说明、响应示例等,如此便能快速在Postman中重建API文档。
(捕获的请求示例)
内置代理与拦截器的不足
Postman的内置代理并不能捕获Https,并且内置代理与拦截器在工作过程中都会获取到大量无用请求,例如图片、CSS等静态资源,因此并不能替代Charles这类Web调试代理工具。相反,将两者配合使用,各取所长,方能事半功倍。
高效地维护API
我们可以利用Postman提供的变量与环境来高效的维护API。
首先,我们按照 Martin Fowler在《重构:改善既有代码的设计》提出的“事不过三,三则重构”的原则,对现在的API进行优化。
例如,对于“添加角色”与“编辑角色”这2个API。
(API:添加角色)
(API:编辑角色)
首先,它们的URL中,协议(Http)、主机(www.app.com)、端口(80)、及部分路径(api)均相同,即存在相同的URL内容。
其次,它们的Header的内容完全相同,而且其中Authorization的值会经常发生变化。
最后,通常我们都会部署开发、测试、生产等几个环境,但当前的API中我们并不能区分出这几个环境,因此需要使得其可适应不同场景。
为此,我们通过Postman的变量与环境来解决这个问题。
变量与环境
Postman中的变量与编程语言中的变量并无差别,都是数据的符号表示,并且通过符号可以访问其对应的值。
环境是变量的集合,即是一个环境中包含了多个变量。
这个问题中,首先我们创建一个develop环境用于开发,并在其中创建Base_Url、Host、Content-Type、Accept、AccessToken等变量。
(develop环境中的变量)
之后,我们复制develop的副本为test与product,并更改对应环境BaseUrl变量的值,这样我们便可以通过切换环境来向不同的服务器发送请求。
最终创建的环境如下:
接着,我们再对之前的API进行修改,把API中重复的部分用变量进行替换(Postman中变量的使用方式为{{变量名}})。
(修改后的API:添加角色)
(修改后的API:编辑角色)
如此一来,我们既能通过变量方便对管理API中经常变化的部分,又能通过环境在开发、测试等工作中自由切换。
关于变量的更多细节
Postman中变量共分为全局变量、集合变量、环境变量、数据变量、本地变量5种,它们的优先级由低到高递增,但生命周期却是由高到低递减。
(Postman中的变量类型,引用自Postman官网)
全局变量
全局变量在整个工作区有效,我们可以通过点击Manage enviroments窗口的Globals按钮进入全局变量的管理界面。
(全局变量的操作入口)
集合变量
集合变量只在特定的集合内有效,因此Postman中集合变量的操作入口并不明显,首先需要点击集合右侧的更多按钮,在弹出的菜单项中选择Edit,进入集合变量编辑界面。
(集合变量的操作入口)
然后切换到Variables选项卡,即可对集合变量进行管理。
(集合变量的编辑界面)
环境变量
只有当环境被启用时,对应的环境变量才会生效。我们可以在Postman的右上角切换当前环境。
(切换环境)
然后在Manage enviroments窗口中点击具体的环境名并进入环境变量的管理界面。
(环境变量的操作入口)
数据变量
数据变量的使用涉及到Runner与Sandbox,暂且不表。
本地变量
本地变量是临时的,只能在请求脚本中访问,并且在请求完成后就被自动删除。
由于本地变量的使用涉及到Pre-request Script(预请求脚本)与Sandbox(沙盒),此处亦暂且不表。
动态变量
动态变量是按照变量的值划分的,普通变量的值是固定的,只有在我们手动更改其值才会发生变化(可在编辑窗口或者Sandbox中使用脚本更改),而动态变量的值则是每次使用时发生改变,且是由Postman动态生成。
Postman内置的动态变量非常多,包含了数值、颜色、IP地址、电话、地址、坐标等众多种类,这些动态变量的名称大多以$random开头,具体的动态变量列表可以参考官方文档。
高效地测试API
Postman为我们提供了丰富的测试功能,我们可以很方便地利用Tests与Runner来实现自动化测试。以“用户-注册”这个API为例:
首先,我们用动态变量代替固定的用户名和邮箱,以此来模拟用户的注册操作。
(包含动态变量的API:注册)
然后,我们在Tests选项卡中用JavaScript编写测试脚本。在编写测试脚本时,我们既可以点击右侧的Snippets示例获取代码,也可以参考Postman的官方文档。
(JavaScript编写的测试脚本)
在接收到响应报文后,Postman会自动在Sandbox中运行对应的测试脚本,并给出测试结果。
(API的测试结果)
Runner
当我们需要自动化的对整个集合的API进行测试时,就需要使用到Runner。
Runner会自动运行集合中的所有API,并可以指定API的环境、迭代次数以及运行每个API的等待间隔,之后Runner将会依次执行这些API,并给出运行结果报告。
(Runner配置界面)
(运行结果报告)
下一篇《Postman(第3期):协作》,敬请期待。