Sử dụng API trong test scenario, test suite
Cấu hình test API mới chỉ là bước tạo ra API trên hệ thống, còn việc sử dụng test API ở đâu, và sử dụng như thế nào sẽ hoàn toàn do người dùng cấu hình trên test scenario, test suite.
Cách sử dụng API trong Test Scenario
Bước 1: Truy cập vào màn hình Low-code thuộc các kịch bản kiểm thử. Tham chiếu Low-code Test scenario.
Bước 2: Sử dụng Key-word Controller là “Client” và cấu hình Platform là Api.
Bước 3: Kéo key-word API CALL vào màn hình low-code bên trong client API
Bước 4: Tiến hành cấu hình Api Call Property, lựa chọn dữ liệu code tại màn hình Api call property
Bước 5: Màn hình hiển thị danh sách API đã được khởi tạo, click chọn 1 API muốn gọi
Bước 6: Chọn api thành công, màn hình Api call property của key word api call có sự thay đổi
| Trường thông tin | Bắt buộc | Định dạng | Ràng buộc | Mô tả |
|---|---|---|---|---|
| Code | Có | AutoComplete | Mã code của api đã chọn tại API Explorer | |
| Enpoints | Có | Combobox | Hiển thị danh sách các Enpoints đã được khởi tạo của API đã được chọn. Người dùng phải chọn 1 giá trị | |
| Request Type | Có | Combobox | Hiển thị danh sách request type: + None: Không sử dụng request body + Multipart-form: Request dạng form có bao gồm File. + Application json: Dùng để gửi dữ liệu JSON trong request body. + Application xml: Dùng để gửi dữ liệu XML trong request body. + Raw: Dùng để gửi dữ liệu trong một định dạng tùy ý, có thể là JSON, XML, hoặc bất kỳ định dạng văn bản nào. Người dùng có thể chọn 1 giá trị. |
Input Param đầu vào sử dụng cho API
| Trường thông tin | Bắt buộc | Định dạng | Ràng buộc | Mô tả |
|---|---|---|---|---|
| Server | Có | Text | Tham số của api mặc định đều phải xuất hiện khi sử dụng API Call. | Địa chỉ của enpoint để call api. Server sẽ kết hợp với path của enpoint để hình thành nên url sử dụng để call api. |
| Các Parameter Input | - | Hiển thị nếu trong Enpoint đã chọn có khai báo Param hoặc trong cấu hình test có khai báo param. | Nhập dữ liệu sử dụng làm tham số đầu vào của các parameter trong api. Lựa chọn nguồn dữ liệu và giá trị của phù hợp với nguồn giá trị của param đã chọn. |
Output Param đầu ra của API
| Trường thông tin | Bắt buộc | Định dạng | Ràng buộc | Mô tả |
|---|---|---|---|---|
| Type | Có | Combobox | Hiển thị danh sách kiểu dữ liệu cho biến output. Người dùng được phép chọn 1 giá trị. | |
| Data Type | Có | Combobox | Mặc định lựa chọn Call Output | Kiểu dữ liệu của biến output hứng Output trả về của endpoint. |
| Name | Có | Text | Tên của biến nhận giá trị output. |
Bước 7: Click button Close để lưu Api call property, ta sẽ được dòng low-code như sau:
Lưu ý: Biến output ở đây sẽ chứa toàn bộ danh sách response trả ra của API, vậy nên muốn lấy ra các param trong response trả về sẽ cần phải cấu hình lấy param trong response.
Bước 8: Sử dụng key-word Assign Value, cấu hình tạo biến để nhận giá trị và giá trị được gán.
Tham số response sẽ dựa theo cấu hình status code và content type của response.
Ví dụ:
- Response có Status Code = 200, Content Type = Application json: tham số response = result_200_json
- Response có Status Code = 500, Content Type = Any: tham số response = result_500
- Response có Status Code = Any, Content Type = Application xml: tham số response = result_xml
Cấu hình biến để nhận giá trị:
Cấu hình giá trị được lấy từ response, tại output được trả về từ API, bộ dữ liệu response trả về được đặt trong phần “result_200_json” với kiểu dữ liệu JSON.
Lấy giá trị id từ response
Bước 9: Click Save phần Low-code, khi tiến hành thực thi kịch bản thì được dữ liệu trả về theo tham số output đã khởi tạo.
