Sử dụng biến

Trong Apidog, biến cho phép bạn lưu và tái sử dụng giá trị một cách dễ dàng. Việc lưu trữ một giá trị dưới dạng biến giúp bạn truy cập giá trị đó trên nhiều môi trường, yêu cầu, script và kịch bản kiểm thử khác nhau. Sử dụng biến giúp tăng năng suất và thúc đẩy làm việc nhóm giữa các đồng nghiệp.

Biến là gì?

Biến là một biểu diễn tượng trưng của dữ liệu, cho phép bạn truy xuất một giá trị mà không cần nhập thủ công mỗi khi cần. Điều này hữu ích khi tái sử dụng cùng một giá trị ở nhiều vị trí khác nhau.

Ví dụ:
Nếu bạn có cùng một token trong nhiều yêu cầu và dự kiến token đó sẽ thay đổi, hãy lưu token dưới dạng một biến có tên {{my_token}}. Sử dụng {{my_token}} trong giá trị tham số của yêu cầu. Khi token thay đổi, việc cập nhật giá trị biến sẽ cập nhật token đó ở mọi nơi.

Biến có thể có hiệu lực trong các giá trị tham số, body, URL hoặc header.

Trong mô-đun Tests của Apidog, biến có thể được sử dụng để truyền dữ liệu giữa các yêu cầu.

Phạm vi của biến

Apidog hỗ trợ biến ở nhiều phạm vi khác nhau để đáp ứng các yêu cầu phát triển, kiểm thử và cộng tác khác nhau.

Độ ưu tiên (từ thấp nhất đến cao nhất): Global < Module < Environment < Data < Local

Khi một biến có cùng tên được định nghĩa trong nhiều phạm vi khác nhau, giá trị từ phạm vi hẹp nhất sẽ được ưu tiên.

Biến Global

Chia sẻ trong dự án: Có thể truy cập trên toàn bộ một dự án. Hữu ích để chia sẻ dữ liệu giữa các endpoint (ví dụ: token đăng nhập).

Chia sẻ trong nhóm: Được chia sẻ trong toàn bộ nhóm trên các dự án khác nhau (ví dụ: token được chia sẻ giữa dự án đăng nhập và dự án tài chính).

NOTE

Quyền: Để quản lý biến của nhóm, bạn cần quyền quản trị viên nhóm. Đi tới Team Resources > Variables.

Script: Bạn có thể sử dụng pm.globals.set để cập nhật giá trị cục bộ trong script, nhưng không thể thay đổi tên hoặc giá trị được chia sẻ.

Biến Module

Được định nghĩa trong một mô-đun. Khi nhập từ Postman, "Collection variables" sẽ được ánh xạ thành biến Module.

Biến Environment

Gắn với các môi trường cụ thể (Development, Testing, Production). Chỉ các biến của môi trường đang hoạt động mới có hiệu lực.

Biến Data

Có nguồn từ các tệp CSV hoặc JSON bên ngoài trong Test Scenarios hoặc CLI. Giá trị không được duy trì sau khi chạy.

Biến Local

Biến tạm thời bị giới hạn trong một yêu cầu hoặc một lần chạy kịch bản kiểm thử. Biến sẽ biến mất sau khi hoàn tất.

TIP

Các biến trong Apidog được lưu trữ dưới dạng chuỗi. Khi lưu đối tượng hoặc mảng, hãy sử dụng JSON.stringify() để lưu trữ và JSON.parse() để truy xuất.

Giá trị chia sẻ và giá trị cục bộ

Mỗi biến có hai trạng thái:

Giá trị chia sẻ: Được đồng bộ hóa với máy chủ Apidog và chia sẻ với nhóm.

Giá trị cục bộ: Được lưu trữ CỤC BỘ trong bộ nhớ đệm của trình duyệt hoặc client của bạn. Không được chia sẻ.

Phương pháp hay nhất:

Sử dụng Giá trị cục bộ cho dữ liệu nhạy cảm (token, mật khẩu) để các dữ liệu này chỉ ở trên máy của bạn.

Để trống Giá trị cục bộ để quay về sử dụng Giá trị chia sẻ.

Nhấp vào biểu tượng liên kết 🔗 để đồng bộ Giá trị cục bộ với Giá trị chia sẻ.

WARNING

Việc xóa bộ nhớ đệm Apidog sẽ xóa các Giá trị cục bộ.

Giá trị cục bộ KHÔNG tự động di chuyển khi chuyển đổi thiết bị (hãy sử dụng Xuất/Nhập môi trường).

Sử dụng biến trong Apidog CLI

Khi chạy trong CLI, Giá trị chia sẻ được sử dụng theo mặc định, trong khi Client sử dụng Giá trị cục bộ. Đây là nguyên nhân phổ biến gây ra sự khác biệt giữa các lần chạy trên Client và CLI.

TIP

Tìm hiểu thêm về Apidog CLI.

Định nghĩa biến

1. Quản lý môi trường (thiết lập sẵn)

Có thể thiết lập sẵn thủ công giá trị cho biến Global và Environment.

Nhấp vào biểu tượng Environment Management ≡.

Chọn Global Variables hoặc một môi trường cụ thể.

Thêm tên biến, giá trị chia sẻ và giá trị cục bộ.

Nhấp vào Save.

2. Trích xuất biến

Trích xuất trực quan các giá trị từ phản hồi API vào biến mà không cần viết mã.

Trong tab Run (Design Mode), đi tới Post Processors.

Chọn Extract Variable.

Cấu hình nguồn trích xuất (JSON, XML, Header, v.v.) và JSONPath.

Gửi yêu cầu để thực thi và xác minh trong Console.

TIP

Tìm hiểu thêm về Extract Variable.

3. Script

Sử dụng đối tượng pm trong Pre/Post-processors.

Cú pháp cho set:

Lưu trữ đối tượng/mảng:

TIP

Tìm hiểu thêm về Script Syntax.

4. Thao tác cơ sở dữ liệu

Kết nối với cơ sở dữ liệu để truy xuất dữ liệu và đặt dữ liệu đó làm biến.

Thêm Database Operation trong Post Processors.

Cấu hình kết nối cơ sở dữ liệu.

Nhập lệnh SQL (hỗ trợ {{variable}}).

Đặt Extract Result To Variable.

TIP

Tìm hiểu thêm về Database Operations.

Tham số yêu cầu

Sử dụng dấu ngoặc nhọn kép {{variable}} trong URL, tham số, header hoặc body.

Ví dụ URL:
http://127.0.0.1/pet/findByStatus?status={{CurrentStatus}}

Ví dụ JSON Body:

{
    "status": "{{CurrentStatus}}",
    "quantity": {{TotalPet}}
}

WARNING

Chuỗi: Thêm dấu ngoặc kép "" quanh biến đối với chuỗi (ví dụ: "{{name}}").

Số/Boolean: KHÔNG thêm dấu ngoặc kép (ví dụ: {{count}}).

Truy cập phần tử con

Nếu một biến chứa đối tượng/mảng JSON, hãy truy cập các thuộc tính thông qua ký pháp dấu chấm bằng JSONPath.

Đối tượng trong {{user}}:

{ "id": 1, "name": "Jack" }

Yêu cầu: {{user.name}}

Script: pm.variables.get("user.name")

Mảng trong {{users}}:

[ { "name": "Jack" } ]

Yêu cầu: {{users[0].name}}

Script: pm.variables.get("users[0].name")

Sử dụng biến trong script

Trong script, sử dụng pm.*.get() thay vì {{}}.

Ghi log:

Kiểm tra tab Console để xem đầu ra.

Sử dụng biến Data

Trong Test Scenarios, việc nhập tệp CSV/JSON sẽ tạo ra "Biến Data". Sử dụng {{column_name}} để tham chiếu đến chúng. Mỗi hàng trong tệp sẽ kích hoạt một vòng lặp riêng.

TIP

Tìm hiểu thêm về Data Driven Testing.

Câu hỏi thường gặp

Hỏi: Tôi có thể sử dụng biến trong Mocks không?

Không. Biến được phân giải khi một yêu cầu được gửi. Mocks là các định nghĩa tĩnh hoặc chạy trên máy chủ mock mà không có ngữ cảnh "gửi" phía client theo cùng cách.

Hỏi: Làm cách nào để lấy base URL trong script?

Sử dụng pm.request.getBaseUrl().

Tránh sử dụng pm.environment.get('BASE_URL') vì nó có thể không chính xác đối với các endpoint máy chủ không mặc định.

Sử dụng biến

Biến là gì?#

Phạm vi của biến#

Giá trị chia sẻ và giá trị cục bộ#

Sử dụng biến trong Apidog CLI#

Định nghĩa biến#

1. Quản lý môi trường (thiết lập sẵn)#

2. Trích xuất biến#

3. Script#

4. Thao tác cơ sở dữ liệu#

Sử dụng biến#

Tham số yêu cầu#

Truy cập phần tử con#

Sử dụng biến trong script#

Sử dụng biến Data#

Câu hỏi thường gặp#

Biến là gì?

Phạm vi của biến

Giá trị chia sẻ và giá trị cục bộ

Sử dụng biến trong Apidog CLI

Định nghĩa biến

1. Quản lý môi trường (thiết lập sẵn)

2. Trích xuất biến

3. Script

4. Thao tác cơ sở dữ liệu

Sử dụng biến

Tham số yêu cầu

Truy cập phần tử con

Sử dụng biến trong script

Sử dụng biến Data

Câu hỏi thường gặp