在開發 API 時,我們需要一個工具來測試 API 是否正常運作,Postman 就是一個非常好用的 API 測試工具。
什麼是 Postman
Postman 是一個 API 開發環境,它提供了一個直觀的介面來建立、測試、記錄和監控 API。無論是 REST API、GraphQL API 或是其他類型的 API,Postman 都能夠幫助開發者進行測試。
Postman 的主要功能
- API 測試:可以發送各種 HTTP 請求(GET、POST、PUT、DELETE 等)
- 環境變數:可以設定不同環境的變數,方便切換測試環境
- 集合管理:可以將相關的 API 請求組織成集合
- 測試腳本:可以撰寫測試腳本來驗證 API 回應
- 文件生成:可以自動生成 API 文件
如何使用 Postman
1. 下載安裝
前往 Postman 官網下載並安裝應用程式,或是使用網頁版。
2. 發送請求
- 選擇 HTTP 方法(GET、POST 等)
- 輸入 API 網址
- 設定 Headers(如果需要)
- 設定 Body(針對 POST、PUT 請求)
- 點擊 Send 發送請求
3. 查看回應
發送請求後,Postman 會顯示:
- 回應狀態碼
- 回應時間
- 回應大小
- 回應內容(JSON、HTML、XML 等格式)
Postman 的進階功能
環境變數
可以設定不同的環境變數,例如:
- 開發環境:
{{base_url}}=http://localhost:3000 - 測試環境:
{{base_url}}=https://test-api.example.com - 生產環境:
{{base_url}}=https://api.example.com
測試腳本
可以在 Tests 標籤中撰寫 JavaScript 程式碼來測試 API 回應:
// 測試狀態碼是否為 200
pm.test("Status code is 200", function () {
pm.response.to.have.status(200);
});
// 測試回應時間是否小於 1000ms
pm.test("Response time is less than 1000ms", function () {
pm.expect(pm.response.responseTime).to.be.below(1000);
});
// 測試回應內容
pm.test("Response contains user data", function () {
const jsonData = pm.response.json();
pm.expect(jsonData).to.have.property('name');
});
為什麼要使用 Postman
- 方便測試:不需要寫程式碼就能測試 API
- 團隊協作:可以分享集合給團隊成員
- 自動化測試:可以設定自動化測試流程
- 文件產生:可以自動產生 API 文件
- 跨平台:支援 Windows、macOS、Linux