Chào các bạn đã đến với chủ để tiếp theo của mình. Hôm nay, mình sẽ tiếp tục giới thiệu về cách gửi request và kiểm tra kết quả của nó. Ở bài này, mình sẽ đi qua những nội dung như sau:
Nội dung
1. Phân tích yêu cầu của api request
Giả sử chúng ta có api request như sau: https://reqres.in/api/users?page=1. Thông thường trước khi bắt tay vào thực hiện test, chúng ta nên có đầy đủ thông tin của API cần test giống như bảng này.
URL | https://reqres.in/api/users?page=1 |
Method | GET |
Header | <none> |
Data Params | <none> |
Success Response | Code: 200 OK Content: { “page”: 1, “per_page”: 6, “total”: 12, “total_pages”: 2, “data”: [ { “id”: 1, “email”: “george.bluth@reqres.in”, “first_name”: “George”, “last_name”: “Bluth”, “avatar”: “https://reqres.in/img/faces/1-image.jpg” }, { “id”: 2, “email”: “janet.weaver@reqres.in”, “first_name”: “Janet”, “last_name”: “Weaver”, “avatar”: “https://reqres.in/img/faces/2-image.jpg” }, { “id”: 3, “email”: “emma.wong@reqres.in”, “first_name”: “Emma”, “last_name”: “Wong”, “avatar”: “https://reqres.in/img/faces/3-image.jpg” }, { “id”: 4, “email”: “eve.holt@reqres.in”, “first_name”: “Eve”, “last_name”: “Holt”, “avatar”: “https://reqres.in/img/faces/4-image.jpg” }, { “id”: 5, “email”: “charles.morris@reqres.in”, “first_name”: “Charles”, “last_name”: “Morris”, “avatar”: “https://reqres.in/img/faces/5-image.jpg” }, { “id”: 6, “email”: “tracey.ramos@reqres.in”, “first_name”: “Tracey”, “last_name”: “Ramos”, “avatar”: “https://reqres.in/img/faces/6-image.jpg” } ], “support”: { “url”: “https://reqres.in/#support-heading”, “text”: “To keep ReqRes free, contributions towards server costs are appreciated!” } } |
Error Response | 404 Not Found (Incorrect path) |
URL: Đây là địa chỉ URL (endpoint) mà request sẽ gởi đi
Method: Phương thức của request, như trong bảng yêu cầu thì phương thức được gởi đi là phương thức GET (ngoài ra còn nhiều phương thức khác như POST, PUT, DELETE…)
Header: Thông tin về headers của một request. Với api này thì ko cần truyền tham số. (Nhưng trong 1 real project, thì thường sẽ có 2 tham số là “Content-Type” và “Authorization”)
Data Params: Chúng ta không cần data parameters trong phương thức GET
Success Response: Kết quả khi request được gởi thành công (gồm code và content/body)
Error Response: Kết quả khi request được gởi thất bại (response code khi gặp lỗi).
Vậy là chúng ta đã hiểu requirement và có những thông tin cần thiết, bây giờ chúng ta sẽ tiến hành tạo request đó trên Postman.
2. Tạo một request trên Postman
On My Workspace, các bạn chọn New. Sau đó chọn HTTP Request
Nhập các thông tin về request:
- Method: mặc định sẽ chọn phương thức GET
- Nhập địa chỉ API cần gởi: “https://reqres.in/api/users?page=1”
- Click Send để gởi request.
Save request:
- Request name: Tên của request, vd: “Get list user”.
- Request description (Optional): Mô tả hoặc chú thích cho request, phần này không bắt buộc và mình sẽ để trống.
- “Save to Collect”: Các bạn nên tạo một collection để lưu trữ các request, một collection giống như một test suite / folder lưu trữ các request nhỏ bên trong để dễ quản lý. Mình sẽ chọn vào “New Collection” và đặt tên là “Dummy API”. Sau khi đặt tên các bạn click vào collection vừa tạo để chọn, lúc này nút Save sẽ được sáng lên để bạn có thể lưu request vào “Dummy API”.
3. Kiểm tra kết quả
Chúng ta có thể xem kết quả ở mục Status. Hiện tại Status: 200 OK cho thấy request đã được gởi thành công. Ngoài ra có thể kiểm tra thêm ở phần response body bên dưới để xem kết quả, danh sách dữ liệu trả về.
{
"page": 1,
"per_page": 6,
"total": 12,
"total_pages": 2,
"data": [
{
"id": 1,
"email": "george.bluth@reqres.in",
"first_name": "George",
"last_name": "Bluth",
"avatar": "https://reqres.in/img/faces/1-image.jpg"
},
{
"id": 2,
"email": "janet.weaver@reqres.in",
"first_name": "Janet",
"last_name": "Weaver",
"avatar": "https://reqres.in/img/faces/2-image.jpg"
},
{
"id": 3,
"email": "emma.wong@reqres.in",
"first_name": "Emma",
"last_name": "Wong",
"avatar": "https://reqres.in/img/faces/3-image.jpg"
},
{
"id": 4,
"email": "eve.holt@reqres.in",
"first_name": "Eve",
"last_name": "Holt",
"avatar": "https://reqres.in/img/faces/4-image.jpg"
},
{
"id": 5,
"email": "charles.morris@reqres.in",
"first_name": "Charles",
"last_name": "Morris",
"avatar": "https://reqres.in/img/faces/5-image.jpg"
},
{
"id": 6,
"email": "tracey.ramos@reqres.in",
"first_name": "Tracey",
"last_name": "Ramos",
"avatar": "https://reqres.in/img/faces/6-image.jpg"
}
],
"support": {
"url": "https://reqres.in/#support-heading",
"text": "To keep ReqRes free, contributions towards server costs are appreciated!"
}
}
Trong trường hợp chúng ta send sai api request thì sao? Mình sẽ thử send với api này: https://reqres.in/api1/users?page=1. Lúc này kết quả sẽ trả về 404 Not Found
Với mỗi lỗi khác nhau sẽ có một response code / body khác nhau, các bạn nên làm rõ yêu cầu của khách hàng trong từng trường hợp.
4. Kết
Đến đây các bạn đã hoàn thành được các bước tạo request, nhập các thông tin cần thiết và gởi đi, cũng như có thể xem và đọc được kết quả trả về từ Postman. Cảm ơn các bạn đã theo dõi bài viết của mình. Chúc các bạn thành công. Hẹn gặp lại các bạn ở những chủ đề tiếp theo. Bái bai.
Nguồn: