Postman高级应用(5):再也不用注释签名代码了——自动生成签名
场景
我们在写服务端接口时候,往往需要考虑安全问题,最基本的一点就是接口需要按照约定的规则进行签名校验。一旦接口校验签名,就意味着我们用Postman不能想以前那样顺利的测试了,服务端必定会返回签名失败。我们在本地开发时候,一定有不少开发同学是通过注释掉验签代码来绕开签名,但往往提交代码时候又不小心提交上去。灵活点的签名校验可能会忽略掉来自本机请求的验签,我们这里假设系统设计的没这么灵活,而且即使这样灵活设计也还是解决不了外网要测试dev qa环境的接口无法通过验签的问题。下面我们就利用Postman强大的Pre-request Script功能来实现自动为每个请求生成服务端需要的签名参数。
Pre-request Script
在开始编写案例之前,先简单介绍一下Postman的Pre-request Script到底是个什么东西?从字面意思能猜测出这是一个在请求之前会执行的脚本,我们看下官方给出的流程图,就可以证明我们的猜想。
Pre-request Script是通过Postman的沙盒(Sandbox)来实现的,而Sandbox是一个JavaScript执行环境,里面内置了一部分常用的JS库和函数(下面会介绍到)。所以我们其实是通过编写JavaScript代码,代码在请求发出前先被执行,从而达到自动生成签名的目的。
实战
先切换到Pre-request Script
选项卡,开始编写JavaScript代码。
假设服务端的签名算法如下:所有请求参数都放在Body
里以json
格式提交,里面必须包含一个当前时间戳ts
以及签名后得到的sign
。对body中除了sign
以外的所有字段签名(暂时不考虑json有数组的情况),先按照key升序
排列,然后以key=value
的形式用&
拼接字符串,最后用签名密钥signKey
对拼接后的字符串进行SHA1
签名得到sign
。我们直接贴代码吧。
(function () {var data = JSON.parse(request.data);var signKey = pm.environment.get('signKey');var sign = calcSign(data, signKey);pm.globals.set('sign', sign);
})();function calcSign(data, signKey) {delete data['sign'];var keys = [];for(var k in data) {keys.push(k);}keys.sort();var kv = [];for (var v of keys) {kv.push(v + '=' + data[v]);}var kvStr = kv.join('&');var sign = CryptoJS.HmacSHA1(kvStr, signKey).toString();return sign;
}
我们还需要在请求的Body
里加上ts
和sign
字段,而且必须用双引号括起来,否则会报错。还要在环境变量或全局变量(视情况而定)里设置signKey
字段,如图所示。
代码中使用到了Postman Sandbox的一些常用的内置函数,这里简单介绍一下。Sandbox内置的类库以及完整的Postman API介绍请看最下面的文档,这里无法一一罗列和演示。
(function(){ ... })()
:jQuery的写法,Sandbox内置了jQuery库。pm.environment.get(variableName)
:获取某个环境变量的值,也可以写成 postman.getEnvironmentVariable(variableName)。pm.globals.set(variableName, variableValue)
:设置某个全局变量,也可以写成 postman.setGlobalVariable(variableName, variableValue)。CryptoJS.HmacSHA1()
:内置的CryptoJS库,几乎涵盖所有加密算法,本案例使用了SHA1,大家根据具体签名规则来选择。{{$timestamp}}
:动态返回当前时间戳。类似的语法还有{{$guid}}
生成唯一ID,{{$randomInt}}
生成0到1000的随机整数。
如果每个请求都要加签名,不必为每个请求都写一份重复的Pre-request Script代码。可以在收藏
或者文件夹
级别统一设置,这样该收藏或文件夹下每一个请求都能执行到。
以上只是Pre-request Script的一个常见的应用场景,它的用途非常之广,等待你去探索!
API文档
- Postman Sandbox
- Postman Sandbox API reference
更多内容请阅读《Postman高级应用》专栏
Postman高级应用(5):再也不用注释签名代码了——自动生成签名相关推荐
- 使用ant自动生成签名的apk
eclipse打包apk发布,每次都要输入签名的密码,而且打包的过程很长.特别是同一个程序要配置不同的标识打包,会很耗时,结合ant的使用,可以一键打包,会方便很多. 1.ant 官网可下载 htt ...
- 不用电脑在手机上实现自动重签名
iOS 10 及以上的系统都是不完美越狱,每次重启后需要重新越狱.大部分用户使用的是个人免费账号进行签名,通过 Cydia Impactor 安装 yalu102.H3lix.doubleH3lix. ...
- android 签名报错,AndroidStudio生成签名apk报错
1.AndroidStudio生成签名apk弹出如下错误 Generate Signed APK: Errors while building APK. You can find the errors ...
- IDEA注释以及创建类自动生成注释
1. 单行注释:// (快捷键:ctrl + /) 2. 多行注释:/* */ (快捷键:ctrl + shift +/) 3. 文档注释:/** */ 4.配置文件注释 ...
- oracle jpa字段加注释,JPA 通过注解自动生成表,添加 字段名、类型、注释
JPA 通过注解自动生成表,添加 字段名.类型.注释 发布时间:2018-04-13 16:27, 浏览次数:3806 , 标签: JPA JPA对象注解类型 @Table - 映射表名 @Id - ...
- 看了这篇 LeetCode 的刷题心得,再也不用抄别人代码了
作者:VioletJack 原文:<LeetCode 算法题刷题心得>https://www.jianshu.com/p/8876704ea9c8 花了十几天,把<算法>看了一 ...
- 看看函数名和注释,AI就能自动生成代码,程序员:这不真实,我要失业
点击上方"视学算法",选择加"星标"或"置顶" 重磅干货,第一时间送达 本文转载自:机器之心 参与:张倩.Racoon X.Jamin 你 ...
- 程序员幸福感拉满:一键为代码自动生成注释的工具,拿走不谢!
提升程序员幸福感的CodeGeeX代码解释功能上线了! 一个"古老的传说":程序员最讨厌的2件事:一是编写程序时要写注释,二是看别人编写的程序里没写注释: 可见,手动为代码添加注释 ...
- 在idea中为类和方法自动生成注释
一.设置类级别的注释(创建类是自动生成注释) 二.设置方法级别的注释 一.设置类级别的注释(创建类是自动生成注释) 图中的代码块: /** * @author ${USER} * @date ${DA ...
最新文章
- python运行非常慢的解决-python执行太慢
- SURF角点检测(python)
- ios下微信标题修改
- linux下缓存命中测试,linux为什么报表缓存缓存未命中?_linux_开发99编程知识库...
- Maven在Eclipse中的实用小技巧
- java中catalina.out_catalina.out 和 catalina.log 的区别和用途
- Redis与数据库缓存一致性问题
- 我的第一本算法书(图解算法)——什么是二叉查找树
- python的sorted函数和operator.itemgetter函数
- 影院售票系统-----一个让你有成就感的小项目,只有一丢丢哦
- ArcGIS10.2最新全套下载地址
- MessageBox confirm弹框确认和取消按钮的使用-回调
- 易乐游装在云服务器_新手搭建云服务器详细过程
- SQLyog使用错误号码2058
- 二维码的生成原理是什么
- Layui数据表格 换行
- 按键精灵9.5.1.11790秒速启动,多余元素全灭版
- nobody用户介绍
- GL-Studio 4.3-1 安装
- JavaScript限时秒杀
热门文章
- php实现教学卡片,如何实现卡片翻阅效果
- TCP网络编程之chat聊天室
- 细数与计算机有关的诺贝尔物理学奖
- 免费的java外文文献,JAVA外文文献翻译[共18页].doc
- C++ L1-034. 点赞
- 图像处理学习笔记之——绪论
- 微信小程序|使用小程序制作一个节日祝福生成器
- 旋转的星星_pygame旋转图像实例_作者:李兴球
- html5实现窗帘,纯 CSS3 实现的窗帘菜单 Accordion
- 少说话多写代码之Python学习048——类的成员(supper函数)