前一篇講了 Method 測試方法,也有提到 Postman 還有一個好用的功能 - Collection,這篇就來介紹一下吧!特別介紹 Collection 是因為前一篇對於測試 API 已經有基礎的認識了,而一個專案通常都會有很多支 API,在有大量的 API 需要測試的情況之下,就可以利用 Collection 來做集合式的快速測試。
Collection 是 Request 的集合,就像是儲存檔案的資料夾,將 Request 存到 Collection,下次要做同樣的測試就可以直接開啟,且分類後也更容易找到。Postman 裡也可以把自己的 Workspace 分享給團隊的夥伴,讓大家可以共同測試與使用。
新增一個 Collection
在這個 Collection 新增一個 Request,或是把已經存在的 Request 加入到 Collection 中
一個 Collection 就完成了!Collection 還有 share 和 Run 的功能可以快速分享與測試,另外還有一些小功能,就來一一介紹吧!
Share 可以透過 Invite 的功能邀請其他有 Postman 帳號的夥伴加入,另外也可以使用 Link 的方式分享給他人,打開 Link 會顯示像圖片一樣的 json 格式的內容(如下圖),裡面包含這個 Collection 的名字以及所包含的 Request 名稱、 API url、使用的方法等等資訊。
要知道 Collection - Run 的功能就要先知道在每一個 Request 都有一個可以 Test 的功能,如圖中要 Test Status 是否為 200,200 是成功狀態碼代表請求成功的意思,而下圖 Test 的結果 Status 確實是 200。
更多的 test code 請看:https://www.getpostman.com/docs/v6/postman/scripts/test_examples
而 Collection 的 Run 功能就是將這些個別的 Requset 的 Test 都統合起來,接下來就實際做做看
1.點下 Collection 的 Run
2.進入到 Collection Runner 的頁面,這邊也可以設置一些環境的變數,像是 Iteration 改成 2,就會重複 Run 兩次,每次 Run 完的結果都會顯示在右邊的區塊。
3.Run 吧!很清楚的可以看到 Test 的結果,對於需要同時測試多個 API 來説,是相當方便的功能。
在 Collection 還有一些細微的小功能,這邊也做個小介紹
點一下 Add Folder 就可以在 Collection 之下再建立資料夾做分類,之所以要特別提出來,是因為在 Collection 之下的資料夾是無法像 Collection 一樣,可以整個資料夾一起 Run。簡單來說,在 Collection 之下的 Folder 就是拿來分類用的。
點一下 Duplicate 會直接複製整個 Collection,包含裡面的 Request 和設定的內容都會一併被複製。
點一下 Export 會出現選擇 Json 檔的內容樣板,分別為:Collection v1、Collection v2、Collection v2.1。
Collection v1 相對於 Collection v2.1 會顯示較多的內容資訊,但 Postman 在 Collection v1 後面括號棄用,反而比較推薦使用 Collection v2.1。
這邊是兩個檔案的比較圖
以相同的內容,Collection v2.1 以比較精簡也比較容易看懂的結構表達出來,雖然 Collection v1 是標注棄用,但是還是可以選擇與下載,想詳細了解差別的話可以兩者都下載下來比較一下。
以上就是 Collection 的基礎介紹,Collection 在同時開發多個 API 或是多個專案的分類整理上,都是很方便的測試方式。它還擁有分享與匯出的功能,可以讓一個專案中多個 API 的統合性更高,也可以更完整的分享給團隊上的夥伴。