Home » API Testing » Cách sử dụng các biến môi trường trong Postman

Cách sử dụng các biến môi trường trong Postman

Update: 22/05/2024

Postman là công cụ phổ biến cho việc phát triển và kiểm thử API. Một trong những tính năng hữu ích của Postman là khả năng sử dụng biến để lưu trữ và truy cập dữ liệu một cách linh hoạt. Postman cung cấp ba loại biến chính: Global Variables, Collection Variables, và Environment Variables. Mỗi loại biến có phạm vi hoạt động và chức năng riêng, giúp bạn quản lý và sử dụng dữ liệu hiệu quả trong các test và request API.

1. Global Variables (Biến toàn cầu)

  • Phạm vi hoạt động: Toàn bộ Workspace
  • Mô tả: Biến toàn cầu có thể được truy cập và sử dụng từ bất kỳ Collection, Environment hoặc script nào trong Workspace của bạn. Loại biến này thích hợp để lưu trữ các giá trị chung cần được sử dụng nhiều lần trong các test và request API khác nhau.

Ví dụ:

  • Bạn có thể tạo một biến toàn cầu có tên baseURL và lưu trữ URL API cơ sở của bạn. Biến này có thể được sử dụng trong bất kỳ request API nào trong Workspace của bạn bằng cách sử dụng cú pháp pm.globals.get('baseURL').

Cách tạo Global Variables:

  1. Mở Postman và chọn tab Variables.
  2. Nhấp vào nút “New Global Variable”.
  3. Nhập tên biến (ví dụ: baseURL) và giá trị của biến (ví dụ: https://api.example.com).
  4. Nhấp vào nút “Save”.

2. Collection Variables (Biến Collection)

  • Phạm vi hoạt động: Collection cụ thể
  • Mô tả: Biến Collection có thể được truy cập và sử dụng trong bất kỳ request API nào thuộc Collection mà nó được định nghĩa. Loại biến này thích hợp để lưu trữ các giá trị cấu hình hoặc dữ liệu cụ thể cho một Collection nhất định.

Ví dụ:

  • Bạn có thể tạo một biến Collection có tên collectionId và lưu trữ ID của Collection. Biến này có thể được sử dụng trong bất kỳ request API nào thuộc Collection đó bằng cách sử dụng cú pháp pm.collectionVariables.get('collectionId').

Cách tạo Collection Variables:

  1. Mở Postman và chọn Collection bạn muốn thêm biến.
  2. Chọn tab “Variables”.
  3. Nhấp vào nút “New Collection Variable”.
  4. Nhập tên biến (ví dụ: collectionId) và giá trị của biến (ví dụ: 12345).
  5. Nhấp vào nút “Save”.

3. Environment Variables (Biến môi trường)

  • Phạm vi hoạt động: Collection hoặc Environment cụ thể
  • Mô tả: Biến môi trường có thể được truy cập và sử dụng trong Collection hoặc Environment mà chúng được định nghĩa. Loại biến này thích hợp để lưu trữ các giá trị cấu hình hoặc dữ liệu cụ thể cho một Collection hoặc Environment nhất định.

Ví dụ:

  • Bạn có thể tạo một biến môi trường có tên apiKey và lưu trữ khóa API của bạn. Biến này chỉ có thể được sử dụng trong các request API thuộc Collection hoặc Environment mà nó được định nghĩa bằng cách sử dụng cú pháp pm.environment.get('apiKey').

Cách tạo Environment Variables:

  1. Mở Postman và chọn Environment bạn muốn thêm biến.
  2. Chọn tab “Variables”.
  3. Nhấp vào nút “New Environment Variable”.
  4. Nhập tên biến (ví dụ: apiKey) và giá trị của biến (ví dụ: YOUR_API_KEY).
  5. Nhấp vào nút “Save”.

4. So sánh các loại biến

Loại biếnPhạm vi hoạt độngMô tả
Global VariablesToàn bộ WorkspaceLưu trữ giá trị chung cho tất cả Collection và Environment
Collection VariablesCollection cụ thểLưu trữ giá trị cấu hình hoặc dữ liệu cho một Collection nhất định
Environment VariablesCollection hoặc Environment cụ thểLưu trữ giá trị cấu hình hoặc dữ liệu cho một Collection hoặc Environment nhất định

5. Lựa chọn loại biến phù hợp

Lựa chọn sử dụng loại biến nào phụ thuộc vào nhu cầu cụ thể của bạn.

  • Sử dụng Global Variables:
    • Khi bạn cần lưu trữ giá trị cấu hình hoặc dữ liệu chung cần được sử dụng nhiều lần trong nhiều test và request API khác nhau.
    • Set biến môi trường: pm.globals.set(key, value);
    • Get giá trị biến môi trường: pm.globals.get(key) hoặc pm.variables.get(key);
    • Clear biến môi trường: pm.globals.unset(key);
  • Sử dụng Collection Variables:
    • Khi bạn cần lưu trữ giá trị cấu hình hoặc dữ liệu chỉ dành riêng cho một Collection nhất định.
    • Set biến môi trường: pm.collectionVariables.set(key, value);
    • Get giá trị biến môi trường: pm.collectionVariables.get(key) hoặc pm.variables.get(key);
    • Clear biến môi trường: pm.collectionVariables.unset(key);
  • Sử dụng Environment Variables:
    • Khi bạn cần lưu trữ giá trị cấu hình hoặc dữ liệu cần được chia sẻ giữa nhiều Collection hoặc Environment.
    • Set biến môi trường: pm.environment.set(key, value);
    • Get giá trị biến môi trường: pm.environment.get(key) hoặc pm.variables.get(key);
    • Clear biến môi trường: pm.environment.unset(key);

6. Lưu ý

  • Biến Collection có ưu tiên hơn biến môi trường khi cả hai cùng được định nghĩa trong một request API thuộc Collection.
  • Bạn có thể sử dụng nhiều loại biến khác nhau trong cùng một Collection hoặc Environment để đáp ứng các nhu cầu cụ thể của bạn.
  • Việc sử dụng Global Variables, Collection Variables và Environment Variables hiệu quả trong Postman giúp bạn quản lý dữ liệu dễ dàng hơn, giảm thiểu lỗi và cải thiện hiệu quả phát triển và kiểm thử API. Lựa chọn loại biến phù hợp phụ thuộc vào nhu cầu cụ thể của bạn và cấu trúc dự án API của bạn.