API測試之Postman使用全指南(原來使用 Postman測試API如此簡單)

Postman

Postman是一個可擴展的API開發和測試協同平臺工具,可以快速集成到CI/CD管道中。旨在簡化測試和開發中的API工作流。

Postman 工具有 Chrome 擴展和獨立客戶端,推薦安裝獨立客戶端。

Postman 有個 workspace 的概念,workspace 分 personal 和 team 類型。Personal workspace 只能自己查看的 API,Team workspace 可添加成員和設置成員權限,成員之間可共同管理 API。

當然我個人使用一般是不登錄的,因為登錄之后會自動將你的測試歷史數據保存到賬戶里,你可以登陸網頁端進行查看。
因為API的很多數據是很敏感的,有的含有Token,或者就是一些私密信息,雖然Postman自己也強調說這樣很安全,不會私下窺探用戶的信息之類的,但是呢還是至少做一點有效的防范吧,自己不上傳,因為網絡并沒有絕對的安全。
所以我每次測試之后會將數據(Case)保存在本地,下次使用或者換設備的情況下將數據拷貝過來又可以繼續使用了。

下面正式開始介紹如何使用Postman吧。

為什么選擇Postman?

如今,Postman的開發者已超過1000萬(來自官網),選擇使用Postman的原因如下:
簡單易用 - 要使用Postman,你只需登錄自己的賬戶,只要在電腦上安裝了Postman應用程序,就可以方便地隨時隨地訪問文件。
使用集合 - Postman允許用戶為他們的API調用創建集合。每個集合可以創建子文件夾和多個請求。這有助于組織測試結構。
多人協作 - 可以導入或導出集合和環境,從而方便共享文件。直接使用鏈接還可以用于共享集合。
創建環境 - 創建多個環境有助于減少測試重復(DEV/QA/STG/UAT/PROD),因為可以為不同的環境使用相同的集合。這是參數化發生的地方,將在后續介紹。
創建測試 - 測試檢查點(如驗證HTTP響應狀態是否成功)可以添加到每個API調用中,這有助于確保測試覆蓋率。
自動化測試 - 通過使用集合Runner或Newman,可以在多個迭代中運行測試,節省了重復測試的時間。
調試 - Postman控制臺有助于檢查已檢索到的數據,從而易于調試測試。
持續集成——通過其支持持續集成的能力,可以維護開發實踐。

如何下載安裝Postman?

Step 1) 官網主頁:https://www.postman.com/downloads/, 下載所需版本進行安裝即可。

在這里插入圖片描述

Step2)安裝完成之后會要求你必須登錄才能使用,沒有賬號可以進行注冊,注冊是免費的。(也可使用Google賬號,不過基本不能登錄,你懂的)

Step3)在Workspace選擇你要使用的工具并點擊“Save My Preferences”保存。


在這里插入圖片描述

Step4)你將看到啟動后的頁面如下


在這里插入圖片描述

如何使用Postman?

下圖是Postman的工作區間,各個模塊功能的介紹如下:

1、New,在這里創建新的請求、集合或環境;還可以創建更高級的文檔、Mock Server 和 Monitor以及API。
2、Import,這用于導入集合或環境。有一些選項,例如從文件,文件夾導入,鏈接或粘貼原始文本。
3、Runner,可以通過Collection Runner執行自動化測試。后續介紹。
4、Open New,打開一個新的標簽,Postman窗口或Runner窗口。
5、My Workspace - 可以單獨或以團隊的形式創建新的工作區。
6、Invite - 通過邀請團隊成員在工作空間上進行協同工作。
7、History - 所有秦秋的歷史記錄,這樣可以很容易地跟蹤你所做的操作。
8、Collections - 通過創建集合來組織你的測試套件。每個集合可能有子文件夾和多個請求。請求或文件夾也可以被復制。
9、Request tab - 這將顯示您正在處理的請求的標題。默認對于沒有標題的請求會顯示“Untitled Request”。
10、HTTP Request - 單擊它將顯示不同請求的下拉列表,例如 GET, POST, COPY, DELETE, etc. 在測試中,最常用的請求是GET和POST。
11、Request URL - 也稱為端點,顯示API的URL。.
12、Save - 如果對請求進行了更改,必須單擊save,這樣新更改才不會丟失或覆蓋。
13、Params - 在這里將編寫請求所需的參數,比如Key - Value。
14、Authorization - 為了訪問api,需要適當的授權。它可以是Username、Password、Token等形式。
15、Headers - 請求頭信息
16、Body - 請求體信息,一般在POST中才會使用到
17、Pre-request Script - 請求之前 先執行腳本,使用設置環境的預請求腳本來確保在正確的環境中運行測試。
18、Tests - 這些腳本是在請求期間執行的。進行測試非常重要,因為它設置檢查點來驗證響應狀態是否正常、檢索的數據是否符合預期以及其他測試。
19、Settings - 最新版本的有設置,一般用不到。


在這里插入圖片描述

如何處理GET請求

Get請求用于從指定的URL獲取信息,不會對端點進行任何更改。
在這里我們使用如下的URL作為演示:

https://jsonplaceholder.typicode.com/users  

在Postman的工作區中:
1、選擇HTTP請求方式為GET
2、在URL區域輸入 鏈接
3、點擊 “Send”按鈕
4、你將看到下方返回200狀態碼
5、在正文中應該有10個用戶結果,表明您的測試已經成功運行。


在這里插入圖片描述

注意:在某些情況下,Get請求失敗可能由于URL無效或需要身份驗證。

如何處理POST請求

Post請求與Get請求不同,因為存在用戶向端點添加數據的數據操作。使用之前GET 請求中相同數據,現在添加我們自己的用戶。
Step 1)創建一個新請求

在這里插入圖片描述

Step 2 )在新請求中
1、選擇HTTP請求方式為GET
2、在URL區域輸入 鏈接:https://jsonplaceholder.typicode.com/users
3、切換到Body選項
在這里插入圖片描述

Step 3) Body選項
1、選中raw選項
2、選擇JSON
在這里插入圖片描述

Step 4) 復制前面GET請求返回的json內容的第一節
更改id為11,更改name以及uesrname和email

[
    {
        "id": 11,
        "name": "Krishna Rungta",
        "username": "Bret",
        "email": "Sincere@april.biz
    ",
        "address": {
            "street": "Kulas Light",
            "suite": "Apt. 556",
            "city": "Gwenborough",
            "zipcode": "92998-3874",
            "geo": {
                "lat": "-37.3159",
                "lng": "81.1496"
            }
        },
        "phone": "1-770-736-8031 x56442",
        "website": "hildegard.org",
        "company": {
            "name": "Romaguera-Crona",
            "catchPhrase": "Multi-layered client-server neural-net",
            "bs": "harness real-time e-markets"
        }
    }
]
在這里插入圖片描述

注意: 檢查Body里用到的JSON格式很重要,以確保數據正確。
檢測的工具比如:https://jsonformatter.curiousconcept.com/

在這里插入圖片描述

Step 5 )發送請求
1、完成上述的信息輸入,點擊Send按鈕
2、Status:應該是201,顯示為創建成功
3、在Body里返回數據


在這里插入圖片描述

如何將請求參數化

數據參數化是Postman最有用的特征之一。你可以將使用到的變量進行參數化,而不是使用不同的數據創建相同的請求,這樣會事半功倍,簡潔明了。
這些數據可以來自數據文件環境變量。參數化有助于避免重復相同的測試,可用于自動化迭代測試。

參數通過使用雙花括號創建:{{sample}}
比如下面的請求:

在這里插入圖片描述

接下來創建一個參數化get請求:
Step 1) 創建一個參數化get請求
1、將HTTP請求設置為GET
2、輸入URL: https://jsonplaceholder.typicode.com/users;將鏈接的域名部分替換為參數,例如{{url}}。請求url現在應該是{{url}}/users。
3、點擊Send按鈕。
應該沒有響應,因為我們沒有設置參數的源,如下圖:
在這里插入圖片描述

Step 2) 使用環境設置所需的參數
1、點擊眼睛圖標
2、單擊Edit將該變量設置為可在所有集合中使用的全局環境。
在這里插入圖片描述

Step 3) 變量--variable
1、將名稱設置為url,該url為https://jsonplaceholder.typicode.com
2、點擊保存按鈕
在這里插入圖片描述

Step 4) 如果看到下面截圖的樣式,請單擊Close
在這里插入圖片描述

Step 5 ) 回到你的Get請求頁面,然后單擊發送Send按鈕,Get請求應該就會返回結果了,如下圖:
在這里插入圖片描述

注意:請確保所有的參數都有準確的源數據,不管是環境變量還是數據文件,以避免出錯。

如何創建Postman Tests

Postman Tests在請求中添加JavaScript代碼來協助驗證結果,如:成功或失敗狀態、預期結果的比較等等。
通常從pm.test開始。它可以與斷言相比較,驗證其他工具中可用的命令。
接下來創建一個包含Tests的請求:
Step 1) 創建一個Get請求
1、切換到Tests選項,右邊是代碼片段選項。
2、從右邊的代碼片段選項里面選中 “Status code: Code is 200”
3、JS代碼就自動出現在窗口中

在這里插入圖片描述

Step 2) 點擊發送請求按鈕。測試結果就顯示出來了,如下圖:
在這里插入圖片描述

Step 3) 回到Tests選項卡,讓我們添加另一個測試。這次我們將比較預期結果和實際結果。
在右邊的SNIPPETS區域選擇"Response body:JSON value check"選項,我們將檢查Leanne Graham是否擁有userid 1。
在這里插入圖片描述

Step 4)
1、將代碼中的“Your Test Name”替換為“Check if user with id1 is Leanne Graham”,以便測試名稱確切描述我們想測試的內容。
2、使用jsonData[0].name代替jsonData.value; 獲取路徑,在獲取結果之前檢查Body。因為Leanne Graham是userid 1,所以jsonData在第一個結果中,這個結果應該從0開始。如果你想獲得第二個結果,那么對后續結果使用jsonData[1] 即可。
3、在eql中,輸入“Leanne Graham”

pm.test("Check if user with id1 is Leanne Graham", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData[0].name).to.eql("Leanne Graham");
});

在這里插入圖片描述

Step 5) 點擊發送請求,可以看到你的請求之后測試結果中有兩項顯示測試通過。
在這里插入圖片描述

注意:
有不同種類的測試可以在Postman中創建。嘗試探索這個工具,看看哪些測試適合你實際測試。

如何創建測試集合

集合在組織測試套件中扮演著重要的角色。它可以被導入和導出,使得在團隊之間共享集合變得很容易。在本教程中,我們將學習如何創建和執行集合。

Step 1) 單擊頁面左上角的New按鈕,如下圖:

在這里插入圖片描述

Step 2) 選擇Collection(集合). 創建collection窗口彈出,如下圖.
在這里插入圖片描述

Step 3) 輸入所需的集合名稱和描述,然后單擊create。
現在已經創建了一個集合。
在這里插入圖片描述

Step 4 ) 和前面的Get請求一樣,點擊保存。
在這里插入圖片描述

Step5 )
1、選擇Postman 測試集合(Test Collection)。
2、點擊保存Postman Test Collection
在這里插入圖片描述

Step 6) Postman test collection現在應該包含了一個請求,如下圖:
在這里插入圖片描述

Step 7) 重復上述的Step4-5,繼續創建請求,這樣,測試集合就應該有2個請求了,如下圖。
在這里插入圖片描述

如何使用Collection Runner 運行集合

有兩種方式來運行一個集合,即Collection Runner和Newman。
Collection Runner:
Step 1) 單擊頁面頂部導入按鈕旁邊的Runner按鈕,如下圖。

在這里插入圖片描述

Step 2)Collection Runner頁面應該出現如下所示。以下是對各個字段的描述
在這里插入圖片描述

Step 3) 做如下設置,運行你的測試集合

  • 選擇Postman測試集合-集合迭代次數為3
  • 設置延遲為2500毫秒
  • 點擊Start Run按鈕
    在這里插入圖片描述

    Step 4) 單擊Run按鈕后將顯示Run結果頁。根據延遲的不同,你應該在測試執行的同時看到顯示的結果。

1、一旦測試完成,你就可以看到測試狀態是通過還是失敗,以及每個迭代的結果。
2、你將看到Get請求的Pass狀態;
3、由于我們沒有任何Post測試,所以應該會出現請求沒有任何測試的消息。


在這里插入圖片描述

可以出在請求中進行測試是多么重要,這樣你就可以驗證HTTP請求狀態是否成功,以及是否創建或檢索了數據。

如何使用Newman運行集合

運行集合的另一種方式是通過Newman。Newman和Collection Runner之間的主要區別如下:
1、Newman是Postman的替代品,所以需要單獨安裝Newman;
2、Newman使用命令行,而Collection Runner使用UI界面;
3、Newman可以用于持續集成。

安裝Newman并運行Collection,步驟如下:
Step 1) 下載并安裝NodeJs: http://nodejs.org/download/
Step 2) 打開命令行窗口并輸入下面命令:

npm install -g newman

安裝后 如下圖:

在這里插入圖片描述

Step 3 )
Newman安裝好之后,讓我們回到Postman的workspace。在Collections框中,單擊三個點 ... 會出現新的選擇選項,可看到Export選項,如下圖:
在這里插入圖片描述

Step 4 )
選擇導出集合,默認使用推薦的集合版本,比如此處是v2.1,然后單擊導出:
在這里插入圖片描述

Step 5 ) 選擇你想要保存的地址之后點擊保存,這里建議專門新建一個文件夾來存放你的Postman tests。
Step 6 ) 另外還需要導出我們的環境(enviroment)。單擊全局環境下拉菜單旁邊的eye圖標,選擇JSON格式下載。選擇你想要的位置,然后單擊Save。最好將環境放在與Step5 導出的集合相同的文件夾中。

在這里插入圖片描述

Step 7 ) 導出Environment 到集合文件夾后,現在回到命令行,將目錄更改為保存集合和環境的位置。

cd C:\Users\Asus\Desktop\Postman Tests

Step 8 ) 使用下面的命令運行你的測試集合:

newman run PostmanTestCollection.postman_collection.json -e Testing.postman_globals.json

運行的結果應該如下圖:


在這里插入圖片描述

關于Newman的一些基礎指導如下:
1、只運行集合(如果沒有環境或測試數據文件依賴關系,則可以使用此選項。)

newman run <collection name> 

2、運行集合和環境(參數-e 是environment)

newman run <collection name> -e <environment name> 

3、使用所需的編號運行集合的迭代。

newman run <collection name> -n <no.of iterations>

4、運行數據文件

newman run <collection name> --data <file name>  -n <no.of iterations> -e <environment name> 

5、設置延遲時間。(這一點很重要,因為如果由于請求在后臺服務器上,完成前一個請求時沒有延遲時間直接啟動下一個請求,測試可能會失敗。)

newman run <collection name> -d <delay time>
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,501評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,673評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,610評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,939評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,668評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,004評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,001評論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,173評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,705評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,426評論 3 359
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,656評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,139評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,833評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,247評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,580評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,371評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,621評論 2 380