Hướng dẫn cách Test API bằng Postman

Postman là gì?

Postman là một App Extensions, cho phép làm việc với các API, nhất là REST, giúp ích rất nhiều cho việc testing. Hỗ trợ tất cả các phương thức HTTP (GET, POST, PUT, DELETE, OPTIONS, HEAD …) Postman cho phép lưu lại các lần sử dụng. Sử dụng cho cá nhân hoặc team lớn.

Cài đặt

Là một công cụ mã nguồn mở (Open Source), Postman có thể dễ dàng tải về. Truy cậo trang chủ link và chọn nền tảng muốn cài đặt như cho Mac, Windows hoặc Linux rồi tiến hành cài đặt.

Cách sử dụng

Làm việc với request get

Để bắt đầu làm quen với việc gởi một request căn bản, mình sẽ có một requirement như sau.

I. Phân tích yêu cầu

Thường trước khi thực hiện kiểm thử API chúng ta nên có đầy đủ thông tin của API cần test giống như bảng này.

1. Get all employees data

This API will retrieving all employees data from the table and return information that included name, salary and age.

URL	https://sangbui.com/api/v1/employees
Method	GET
URL Params	<none>
Header	Content-Type: application/jsonAuthorization: Basic d2ViX2FwcDpjaGFuZ2VpdA==
Data Params	<none>
Success Response	Code: 200 OKContent:[{“id”: “<id>”,“employee_name”: “<name>”,“employee_salary”: “<salary>”,“employee_age”: “<age>”},{“id”: “<id>”,“employee_name”: “<name>”,“employee_salary”: “<salary>”,“employee_age”: “<age>”}]
Error Response	404 Not Found (Incorrect path)401 Unauthorized (Incorrect permission)
Sample Call	<none>
Notes	<none>

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…)

URL Params: Tham số truyền thêm vào URL, hiện tại yêu cầu là không cần tham số nào khác trên URL

Header: Thông tin về headers của một request, hiện tại chúng ta có 2 khoá 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.

II. Tạo một request trên Postman

Trên Header Bar, các bạn chọn New. Sau đó chọn Request

Nhập các thông tin về request.

• Request name: Tên của request, vd: “Get all employees data”.
• 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.
• “+ Create Collection”: 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 Create Collection và đặt tên là “Employees 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 “Employees API”.

Sau khi tạo mới một request, các bạn chuyển qua phần Builder để nhập các thông tin cần thiết như hình bên dưới.

• Method: mặc định sẽ chọn phương thức GET
• Nhập địa chỉ API cần gởi: “https://sangbui.com/api/v1/employees”
• Chọn tab Headers, nhập thông tin về header bao gồm Content-Type, Authorization và giá trị của các khoá như trong bảng yêu cầu phía trên.
• Chọn Send để gởi request.

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ề.

Vậy nếu thông tin nhập không đúng thì kết quả sẽ ra sao?

Mình sẽ thử sửa lại giá trị chỗ Authorization và gởi lại request.

Kết quả trả về là 401 Unauthorized (không thành công) và có thông báo “Please check the authorization“.

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.

Đế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.

Link tham khảo :

Postman 03 – Gởi một request đầu tiên và kiểm tra kết quả

https://viblo.asia/p/huong-dan-su-dung-postman-cho-test-api-aWj53Lb1K6m

You need to login in order to like this post: click here