Postman 這麼強大的工具怎能不寫一篇簡單的工具應用篇博文呢,本文介紹的是 Pre-request scripts 的使用,是基礎使用的進階版。
一、背景
當我們在對 api 進行測試時,很多時候,請求引數中會涉及一些加密的引數等,比如簽名。
當我們使用 Postman 進行測試時,我們希望的是當我們定義好籤名的加密演算法後,Postman 可以自動幫我們進行計算並作為引數傳遞。
本文就先圍繞簽名的自動化生成為例,涉及 Base64編碼 和 MD5 加密。
二、使用
1、佔位符說明
先舉一個請求地址的栗子:http://localhost:9090/apps/task/inWorkList/{{token}}?signed={{signed}}
注意到地址中的 token 和 signed 的佔位寫法是使用兩對花括號進行包裹,然後我們在其它地方進行計算生成後會替換此處的引數,
替換後的地址為:http://localhost:9090/apps/task/inWorkList/1qaz2wsx?signed=1qaz2wsx
注:同樣的佔位符寫法,我們可以應用在 URI、Headers、Body 中。
2、變數介紹
在上文介紹的佔位符,其實取值來源是 Postman 的變數。
在 Postman 中變數是有全域性變數(global)和環境變數(environment)的區分的,並且都是 k-v 的鍵值對形式。
注:value 一般都是 string 格式,我們在使用的時候要使用 JSON.stringify() 和 JSON.parse() 來進行序列化和反序列化。
正如名字所示,全域性變數是可以在任意一個地方使用的,而環境變數僅在當前環境下使用,當然,如果在兩處定義了相同的key,比如在兩處都定義了 signed:1qaz2wsx 的k-v鍵值對,則環境變數具有較高的優先順序。
3、變數管理
有兩種方式,一是直接在客戶端進行操作,如圖:
二是在 Pre-request 區域使用程式碼進行 get 和 set,一看便知:
// 清除全域性變數
pm.globals.unset("variable_key");
// 清除環境變數
pm.environment.unset("variable_key");
// 獲取全域性變數
pm.globals.get("variable_key");
// 獲取變數
pm.variables.get("variable_key");
// 獲取環境變數
pm.environment.get("variable_key");
// 設定全域性變數
pm.globals.set("variable_key", "variable_value");
// 設定環境變數
pm.environment.set("variable_key", "variable_value");
複製程式碼
其實在客戶端有常用操作的提示:
4、程式碼詳解
直接貼程式碼,說明:此處的 token 和 signed 的生成需要依賴時間戳(形似:20181225224000),該時間戳是採用 JS 的 Date() 慢慢拼接出來的。
token 是 base64 編碼。
signed 是 MD5 加密。
// 變數
// uid
var uid = '7777'
var api_sig_str = pm.variables.get("api_signed_str");
// 時間
var d = new Date()
var year = d.getFullYear().toString()
var month = (d.getMonth() + 1).toString()
month = dateLengtgInit(month)
var day = d.getDate().toString()
day = dateLengtgInit(day)
var hour = d.getHours().toString()
hour = dateLengtgInit(hour)
var minute = d.getMinutes().toString()
minute = dateLengtgInit(minute)
var second = d.getSeconds().toString()
second = dateLengtgInit(second)
var time = year + month + day + hour + minute + second
console.log(time)
// token(base64)
var token = CryptoJS.enc.Base64.stringify(uid + time)
console.log(token)
// postman.setGlobalVariable("token",token)
pm.environment.set("token",token)
//signed (md5加密)
var signed = api_sig_str + '_' + uid + '_' + time
console.log(signed)
var signedMd5 = CryptoJS.MD5(signed).toString()
console.log(signedMd5)
// pm.globals.set("signed",signedMd5)
pm.environment.set("signed",signedMd5)
// 方法定義
function dateLengtgInit(num){
if (num.length==1){
return "0"+num;
} else {
return num
}
}
複製程式碼
5、踩坑
此時執行的時候會報錯:
There was an error in evaluating the Pre-request Script: TypeError: r.clamp is not a function
慢慢除錯發現,其實是 base64 編碼的時候有誤,我們需要先進行 Utf8 編碼,
即將下段程式碼:var token = CryptoJS.enc.Base64.stringify(uid + time)
變更成:var token = CryptoJS.enc.Base64.stringify(CryptoJS.enc.Utf8.parse(uid + time))
三、參考
官方文件:連結地址