[Postman series] Variables, Environments, Globals

Published in

Eway Engineering

4 min readOct 13, 2018

Biến trong Postman cho phép bạn định nghĩa và tái sử dụng lại một số giá trị thường xuyên được dùng tới trong quá trình phát triển sản phẩm hoặc trong những dự án nhất định. Biến có thể sử dụng ở bất kỳ nơi nào trong một request: URL, URL parameters, headers, authorization, request body, header presets, script…

Variable scopes:

Postman có 5 scopes cho biến:

Global variable: biến có thể truy cập ở bất kỳ đâu
Collection variable: biến có thể truy cập từ một request nằm trong collection tương ứng.
(Collection trong Postman sẽ được đề cập tới ở phần dưới)
Environment variable: biến có thể truy cập với Environment tương ứng.(Environment trong Postman sẽ được đề cập tới ở phần dưới)
Data variable: Nếu bạn sử dụng Collection Runner, Postman cho phép import data từ file và sử dụng các biến được import trong Collection đó.
Local variable: là các biến được khai báo trong scripts. Postman không đề cập chi tiết tới việc local variable có thể sử dụng trực tiếp trên URL, URL parameters…hay không, nhưng qua thử nghiệm mình nhận thấy nó chỉ được sử dụng cục bộ trong script đó. Tuy nhiên, Postman cung cấp một số hàm thao tác với Environment & Global variables:
pm.environment.set("variable_name","value")
pm.environment.get("variable_name")
pm.environment.unset("variable_name")
pm.globals.set("variable_name","value")
pm.globals.get("variable_name")
pm.globals.unset("variable_name")

Xử lý xung đột giữa các scope:

Khi một biến thuộc nhiều hơn 1 scope, Postman sử dụng mô hình phân cấp như bên dưới để lựa chọn scope của biến đó. Cụ thể: Nếu một biến nằm trong các scope khác nhau, biến sẽ nhận giá trị của scope có độ ưu tiên cao hơn tính từ trong ra ngoài.

Ví dụ: Một biến thuộc Global scope vàCollection scope thì biến đó sẽ nhận giá trị theo Collection scope.

GLOBAL SCOPE

Global variables là một tập hợp các key — value (tên biến và giá trị) có thể truy cập từ bất cứ scope nào.

Quản lý các biến global:

Click vào biểu tượng “Manage Environments” tại góc phải phía trên cửa sổ:

Click chọn button Globals phía bên đưới:

Cửa sổ quản lý biến global như sau:

Ý nghĩa các trường:

VARIABLE: tên biến.
INITAL VALUE: biến khởi tạo ban đầu, giá trị này sẽ được sử dụng khi bạn chia sẻ với người khác.
CURRENT VALUE: giá trị của biến sau khi được thay đổi bằng script.
Mặc định, CURRENT VALUE = INITAL VALUE.

Lưu ý: Để INITAL VALUE không bị thay đổi theo CURRENT VALUE, thay đổi thiết lập như sau: Preferences > General > Automatically persist variable values = OFF.

ENVIRONMENT SCOPE

Giả sử bạn phát triển sản phẩm trên các môi trường develop, production, …
Thông thường, mỗi khi chuyển môi trường bạn phải thay đổi các giá trị như domain, authorization, … Để đơn giản hoá việc thay đổi các giá trị trên mỗi môi trường, Postman cung cấp Environment scope. Trong đó Environment variables cũng là các cặp giá trị key — value, tuy nhiên các biến này chỉ được truy cập trong phạm vi Environment mà request trực thuộc.

Tạo mới một môi trường:

Click button +NEW tại góc trái bên phải > Chọn Environment

Cửa sổ quản lý Environment như sau:

Ý nghĩa các trường:

ENVIRONMENT NAME: tên môi trường.
VARIABLE: tên biến.
INITAL VALUE: biến khởi tạo ban đầu, giá trị này sẽ được sử dụng khi bạn chia sẻ với người khác.
CURRENT VALUE: giá trị của biến sau khi được thay đổi bằng script.
Mặc định, CURRENT VALUE = INITAL VALUE.

IMPORT, EXPORT AND SHARE DATA

Export Global variables:

Tại cửa sổ quản lý Global variables, click button Download as JSON, chúng ta sẽ có một file json lưu trữ thông tin các biến như sau:

{
“id”: “xxxxx-xxxxxx-xxxxxx-xxxxx-xxxxxxxx”,
“values”: [
{
“key”: “demo_url”,
“value”: “tinhte.vn”,
“description”: {
“content”: “”,
“type”: “text/plain”
},
“enabled”: true
}
],
“name”: “My Workspace Globals”,
“_postman_variable_scope”: “globals”,
“_postman_exported_at”: “2018–10–13T15:03:02.873Z”,
“_postman_exported_using”: “Postman/6.4.2”
}