REST API
1. Kiểm thử API
1.1 API Testing là gì?
API (Application Programming Interface) là một bộ giao diện và tập hợp các quy tắc mà một ứng dụng, dịch vụ hoặc thư viện cung cấp để cho phép các ứng dụng khác tương tác và sử dụng chức năng của nó.
API testing là một loại kiểm thử phần mềm liên quan đến việc kiểm thử các giao diện lập trình ứng dụng (APIs) một cách trực tiếp và là một phần của kiểm thử tích hợp để xác định xem hệ thống có đáp ứng các yêu cầu về tính năng, độ tin cậy, hiệu suất và bảo mật.
1.2 REST API
REST (REpresentational State Transfer) là một dạng chuyển đổi cấu trúc dữ liệu, một kiểu kiến trúc để viết API. Nó sử dụng phương thức HTTP đơn giản để tạo cho giao tiếp giữa các máy. Vì vậy, thay vì sử dụng một URL cho việc xử lý một số thông tin người dùng, REST gửi một yêu cầu HTTP như GET, POST, DELETE, vv đến một URL để xử lý dữ liệu.
REST API là một tiêu chuẩn dùng trong việc thiết kế các API cho các ứng dụng web để quản lý các resource. RESTful là một trong những kiểu thiết kế API được sử dụng phổ biến ngày nay để cho các ứng dụng (web, mobile…) khác nhau giao tiếp với nhau.
1.3 Mục tiêu của kiểm thử API
- Đảm bảo tính chính xác của dữ liệu: đầu ra từ API phải khớp với kỳ vọng khi cung cấp đầu vào cụ thể
- Xác minh chức năng: đảm bảo API thực hiện đúng các chức năng được định nghĩa.
- Kiểm tra hiệu suất: đảm bảo API hoạt động nhanh chóng và hiệu quả, kể cả khi có lưu lượng lớn
- Bảo mật: kiểm tra khả năng xử lý các vấn đề liên quan đến quyền truy cập, xác thực và bảo vệ dữ liệu.
- Xử lý lỗi: đảm bảo API trả về thông báo lỗi đúng và hợp lý khi gặp vấn đề.
1.4 Kiểm thử API trên LLQ QA Platform
1.4.1 Tạo API
Bước 1: Trên màn hình thư viện API test, click “New test”
 |
Hệ thống hiển thị màn hình “CREATE API”
 |
Bước 2: Nhập đầy đủ và hợp lệ các trường thông tin bắt buộc, trong đó:
|
Tên trường |
Bắt buộc |
Định dạng |
Ràng buộc |
Mô tả |
|
General information |
||||
|
Directory |
- |
Button |
Nếu Directory = Root thì test case thuộc directory gốc |
Hiển thị danh sách các directory thuộc project ở tab API, cho phép người dùng chọn 1 directory cho API |
|
Test code |
- |
Text |
Nếu người dùng nhập code thì code phải là duy nhất, độ dài tối thiểu 2 ký tự, bắt đầu bằng chữ cái, chỉ chứa các ký tự từ a-z (viết thường, viết hoa), chữ số, "_" và "-" |
Là mã dùng để định danh kịch bản kiểm thử trên hệ thống Nếu code bỏ trống, hệ thống sẽ tự sinh theo cấu trúc T-stt, trong đó stt là số thứ tự của test trong số các kịch bản kiểm thử được đánh mã tự động của Project |
|
Test name |
Có |
Textbox |
|
Là tên của kịch bản kiểm thử Người dùng nên đặt tên có nghĩa, liên quan đến chức năng/ trường hợp kiểm thử của test được khởi tạo |
|
Tên trường |
Bắt buộc |
Định dạng |
Ràng buộc |
Mô tả |
|
Module |
Có |
Combobox |
Hiển thị danh sách module active của dự án kiểm thử |
Cho phép người dùng chọn 1 module của dự án kiểm thử. Test thuộc module nào sẽ chọn module đó |
|
Version |
Có |
Combobox |
Hiển thị danh sách version active của dự án kiểm thử |
Cho phép người dùng chọn phiên bản của dự án kiểm thử. Test này thuộc phiên bản nào sẽ chọn phiên bản đó |
|
Label |
- |
Button |
|
Chọn 1 hoặc nhiều nhãn mà người dùng muốn gắn. |
|
Purpose |
- |
Textarea |
|
Cho phép người dùng nhập mục đích của test api |
|
Precondition |
- |
Textarea |
|
Cho phép người dùng nhập điều kiện tiên quyết của test api |
|
Test steps |
- |
Textarea |
|
Cho phép người dùng nhập các bước thực hiện trong test api |
|
Expect result |
- |
Textarea |
|
Cho phép người dùng nhập kết quả mong muốn của test api |
|
Tên trường |
Bắt buộc |
Định dạng |
Ràng buộc |
Mô tả |
|
Test data |
- |
Textarea |
|
Cho phép người dùng nhập dữ liệu test của test api |
|
Task Code |
- |
Text |
Task code là duy nhất |
Nhập task code
Trường hợp không nhập task code, hệ thống tự sinh task code theo số thứ tự task của project |
|
Task Name |
Có |
Text |
|
Là tên của task được giao khi thực hiện xây dựng kiểm thử API |
|
Task priority |
Có |
Combobox |
|
Mức độ ưu tiên của task Highest: Cao nhất High: Cao Medium: Trung bình Low: Thấp Lowest: Thấp nhất |
|
Task difficulty |
Có |
Combobox |
|
Phân cấp mức độ khó của task Very Hard: Rất khó Hard: Khó Medium: Trung |
|
Tên trường |
Bắt buộc |
Định dạng |
Ràng buộc |
Mô tả |
|
|
|
|
|
bình Easy: Dễ Very Easy: Rất dễ |
|
Assign to |
- |
Select |
Chỉ hiển thị danh sách user trong project Nếu bỏ trống, hệ thống mặc định Assign to người tạo API |
Là người thực hiện task của API này Sau khi click vào ô Assign to, hệ thống hiển thị màn hình danh sách user, click chọn một user và click OK |
|
Schedule End Date |
- |
Calendar |
|
Là ngày kết thúc thực hiện task |
|
|
- |
Button |
|
Click “Save”, hệ thống validate thông tin, nếu thành công thì api được lưu và hiển thị trên lưới danh sách API của directory đã chọn |
|
|
- |
Button |
|
Click “Cancel” để huỷ bỏ thao tác tạo API, hệ thống reset form và quay lại màn hình thư viện API |
Bước 3: Click “Save”, hệ thống thông báo “Create successful” và điều hướng đến màn hình config API
Click “Back” để quay lại màn hình Test Management tab API
1.4.2 Cấu hình Test API – Low code
Low-code: là chức năng cấu hình api, xây dựng Servers, Endpoints, Schemas để thực hiện các bước trong 1 API Test.
Để truy cập vào màn hình low-code test api, người dùng thực hiện click vào dòng dữ liệu của API tương ứng.
 |
Hệ thống hiển thị màn hình Low-code
Các chức năng trong màn hình low-code
|
Chức năng |
Mô tả |
|
|
Tạo mới Server |
|
|
Tạo mới Endpoint |
|
|
Tạo mới Schema |
|
|
1. Danh sách các servers
2. Danh sách các Endpoints
3. Danh sách các Schemas
Click button |
|
|
Search: Chức năng cho phép người dùng tìm kiếm các Endpoint hoặc Schema name |
|
|
Chức năng cho phép người dùng chuyển sang màn hình metadata của test api từ màn hình low-code |
|
|
Click button “Back” để quay lại màn hình thư viện script |
|
|
Click button “Back” để quay lại màn hình thư viện script |
để tạo mới tương 
1.5 Servers
- Servers được tạo để nhằm mục đích thống kê, lưu trữ các server, chuỗi chứa tên miền của URL sẽ thực hiện gọi API.
- Server của API sẽ được khai báo khi thực hiện gọi test api trong test case, test script hay test suite. Tại màn hình config API Explore, khi play Endpoint, servers được select từ danh sách sever của API.
1.5.1 Thêm mới servers
Bước 1: Trong màn hình Low-code, thực hiện click “New Server” hoặc button
“
”để thực hiện tạo mới 1 server
 |
Bước 2: Hệ thống hiển thị màn hình thêm mới server, người dùng tiến hành nhập
và click “Save”
 |
Thêm mới thành công hệ thống thông báo “Update successful” và hiển thị server đã
khai báo trong danh sách servers
1.5.2 Chỉnh sửa server
Bước 1: Tại màn hình Low-code của test API, người dùng thực hiện chọn dòng dữ liệu server muốn thay đổi.
Bước 2: Chỉnh sửa thông tin cần thay đổi và click “Save”
 |
Hệ thống hiển thị thông báo “Update successful” và hiển thị server đã chỉnh sửa trong danh sách servers.
1.5.3 Delete Servers
Bước 1: Tại màn hình Low-code của test API, người dùng thực hiện click button
“
” trên dòng dữ liệu server muốn xóa và chọn Delete.
 |
Hệ thống hiển thị popup xác nhận xoá
 |
Bước 2: Click “DELETE”, hệ thống thông báo “Update successful”