Postman 使用教學

目錄

1. Postman 簡介
2. 安裝與設置
3. 基本功能介紹
4. 進階功能使用
5. 最佳實踐
6. 常見問題解決
7. 實例教學

1. Postman 簡介

1.1 什麼是 Postman？

Postman 是一個功能強大的 API 開發和測試工具，它提供：

• API 請求發送與測試
• 自動化測試腳本編寫
• API 文檔生成
• 團隊協作功能
• 環境變數管理
• API 監控

1.2 主要優點

• 直觀的圖形化介面
• 強大的測試功能
• 完整的文檔支援
• 豐富的擴展功能
• 支援多種認證方式
• 團隊協作便利性

2. 安裝與設置

2.1 下載安裝

1. 訪問 Postman 官網
2. 選擇適合的版本下載
3. 執行安裝程序
4. 註冊或登入 Postman 帳號

2.2 初始設置

1. 工作空間創建：

   My Workspace → Create Workspace

2. 環境配置：

   Environments → Add

3. 基本設置：

   • 設置默認請求標頭
   • 配置代理設置（如需要）
   • 設置 SSL 證書

3. 基本功能介紹

3.1 發送請求

GET 請求示例

GET https://api.example.com/users
Headers:
  Content-Type: application/json
  Authorization: Bearer your-token

POST 請求示例

POST https://api.example.com/users
Headers:
  Content-Type: application/json
  Authorization: Bearer your-token
Body:
{
  "name": "John Doe",
  "email": "john@example.com"
}

3.2 請求方法

Postman 支援所有標準 HTTP 方法：

• GET：獲取資源
• POST：創建資源
• PUT：更新資源
• DELETE：刪除資源
• PATCH：部分更新
• HEAD：獲取頭資訊
• OPTIONS：獲取可用選項

3.3 請求參數設置

1. 查詢參數（Query Params）：

   https://api.example.com/users?page=1&limit=10

2. 請求標頭（Headers）：

   {
    "Content-Type": "application/json",
    "Authorization": "Bearer token",
    "Accept": "application/json"
   }

3. 請求體（Body）支援格式：

   • raw (JSON, XML, Text)
   • form-data
   • x-www-form-urlencoded
   • binary

4. 進階功能使用

4.1 環境變數

設置環境變數

{
  "baseUrl": "https://api.example.com",
  "authToken": "your-auth-token",
  "apiVersion": "v1"
}

使用環境變數

GET {{baseUrl}}/{{apiVersion}}/users
Authorization: Bearer {{authToken}}

4.2 測試腳本

基本測試示例

pm.test("狀態碼是 200", function () {
    pm.response.to.have.status(200);
});

pm.test("響應包含預期數據", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.name).to.eql("John Doe");
});

預請求腳本

// 設置時間戳
pm.environment.set("timestamp", new Date().getTime());

// 生成隨機數
pm.variables.set("random", Math.random().toString(36).substring(7));

4.3 集合運行器

1. 創建測試集合
2. 設置運行順序
3. 配置運行環境
4. 設置延遲時間
5. 導出測試報告

5. 最佳實踐

5.1 組織結構

1. 使用合理的命名約定

   [方法] 端點名稱 - 描述
   GET Users - List All Users

2. 按功能分組請求

   - Authentication
    |- Login
    |- Logout
    |- Reset Password
   - Users
    |- Get Users
    |- Create User
    |- Update User

5.2 環境管理

1. 創建多個環境

   • Development
   • Staging
   • Production

2. 使用變數

   {
    "dev": {
      "baseUrl": "https://dev-api.example.com"
    },
    "prod": {
      "baseUrl": "https://api.example.com"
    }
   }

6. 常見問題解決

6.1 認證問題

1. Bearer Token 認證

   Authorization: Bearer {{token}}

2. Basic Auth

   Authorization: Basic {{base64Credentials}}

3. OAuth 2.0 設置

   • 選擇 Auth Type: OAuth 2.0
   • 配置授權 URL
   • 設置 client ID 和 secret
   • 獲取 access token

6.2 SSL 證書問題

1. 關閉 SSL 驗證
2. 導入自簽名證書
3. 設置代理伺服器

7. 實例教學

7.1 RESTful API 測試

用戶 CRUD 操作

# 創建用戶
POST {{baseUrl}}/users
Content-Type: application/json

{
    "name": "John Doe",
    "email": "john@example.com"
}

# 獲取用戶
GET {{baseUrl}}/users/{{userId}}

# 更新用戶
PUT {{baseUrl}}/users/{{userId}}
Content-Type: application/json

{
    "name": "John Updated"
}

# 刪除用戶
DELETE {{baseUrl}}/users/{{userId}}

7.2 自動化測試腳本

// 預請求腳本
pm.environment.set("timestamp", new Date().getTime());

// 測試腳本
pm.test("響應時間少於 200ms", function () {
    pm.expect(pm.response.responseTime).to.be.below(200);
});

pm.test("狀態碼是 200", function () {
    pm.response.to.have.status(200);
});

pm.test("響應格式是 JSON", function () {
    pm.response.to.be.json;
});

7.3 監控設置

1. 創建監控

   • 選擇需要監控的請求
   • 設置運行頻率
   • 配置通知規則

2. 監控指標

   • 響應時間
   • 成功率
   • 正常運行時間
   • 錯誤率

結論

Postman 是一個強大的 API 開發和測試工具，掌握其基本和進階功能可以大大提高開發效率。通過本教學，您應該能夠：

1. 熟練使用基本功能
2. 設置和管理環境變數
3. 編寫測試腳本
4. 實現自動化測試
5. 進行 API 監控

補充資源

1. Postman 官方文檔
2. Postman API Network
3. Postman 社群論壇