Hướng dẫn sử dụng Postman cho test API

Postman là gì?

Postman hiện là một trong những công cụ phổ biến nhất được sử dụng trong thử nghiệm các API. Được phát triển vào năm 2012 như một dự án phụ của Abhinav Asthana để đơn giản hóa quy trình làm việc API trong thử nghiệm và phát triển. API là viết tắt của Application Programming Interface (Giao diện lập trình ứng dụng) cho phép các ứng dụng phần mềm giao tiếp với nhau thông qua các lệnh gọi API.

Tại sao sử dụng Postman?

Với hơn 8 triệu người phát triển sử dụng hiện nay, Postman đã trở thành một công cụ được lựa chọn vì những lý do sau:

1. Khả năng truy cập – Để sử dụng Postman, người dùng chỉ cần đăng nhập vào tài khoản của chính họ để dễ dàng truy cập tệp mọi lúc, mọi nơi miễn là ứng dụng Postman được cài đặt trên máy tính.
2. Sử dụng Collections (Bộ sưu tập) – Postman cho phép người dùng tạo bộ sưu tập cho các lệnh gọi API của họ. Mỗi bộ sưu tập có thể tạo các thư mục con và nhiều yêu cầu (request). Điều này giúp việc tổ chức các bộ thử nghiệm.
3. Cộng tác – Bộ sưu tập và môi trường có thể được nhập hoặc xuất giúp chia sẻ tệp dễ dàng. Liên kết trực tiếp cũng có thể được sử dụng để chia sẻ bộ sưu tập.
4. Tạo môi trường – Có nhiều môi trường hỗ trợ ít lặp lại các bài kiểm tra vì người dùng có thể sử dụng cùng một bộ sưu tập nhưng cho một môi trường khác. Đây là nơi tham số hóa sẽ diễn ra mà chúng ta sẽ thảo luận trong các bài học tiếp theo.
5. Tạo thử nghiệm – Các điểm kiểm tra thử nghiệm như xác minh trạng thái phản hồi HTTP thành công có thể được thêm vào mỗi lệnh gọi API giúp đảm bảo phạm vi kiểm tra.
6. Kiểm tra tự động hóa – Thông qua việc sử dụng Bộ sưu tập chạy hoặc Newman, các thử nghiệm có thể được chạy trong nhiều lần lặp lại tiết kiệm thời gian cho các thử nghiệm lặp đi lặp lại.
7. Gỡ lỗi – Bảng điều khiển Postman giúp kiểm tra dữ liệu nào đã được truy xuất giúp dễ dàng gỡ lỗi kiểm tra.
8. Tích hợp liên tục – Với khả năng hỗ trợ tích hợp liên tục, các hoạt động phát triển được duy trì.

Cách Download và cài đặt POSTMAN

Là một công cụ mã nguồn mở (Open Source), Postman có thể dễ dàng tải về, đây là các bước cài đặt:

Bước 1) Truy cập trang https://www.getpostman.com/downloads/ và chọn nền tảng muốn tải về như cho Mac, Windows hoặc Linux. Kích Download.

Bước 2) File tải về sẽ được hiển thị ở dưới cửa sổ của trình duyệt. Khi quá trình tải về hoàn tất, kích nút Run.

Bước 3) Bắt đầu cài đặt

Bước 4) Trong màn hình kế tiếp, đăng nhập với một tài khoản Postman

Chú ý: Có hai cách để đăng nhập vào tài khoản Postman. Một cách tạo một tài khoản riêng trên hệ thống của Postman và một cách khác sử dụng tài khoản Google. Mặc dù Postman cho phép người dùng sử dụng công cụ mà không cần đăng nhập, nhưng việc đăng ký tài khoản đảm bảo rằng bộ sưu tập của bạn được lưu và có thể được truy cập để sử dụng sau.

Bước 5) Chọn các công cụ cho workspace (màn hình làm việc) và kích nút Save My Preferences

Bước 6) Bạn sẽ nhìn thấy màn hình Startup

Cách sử dụng Postman

Bên dười là cửa sổ làm việc của Postman. Hãy tìm hiểu các chức năng của công cụ này!

1. New – Đây là nơi bạn sẽ tạo request, collection hoặc enviroment mới.
2. Import – Được sử dụng để import collection hoặc environment. Có các tuỳ chọn để import từ file, folder, link hoặc paste từ text thuần.
3. Runner – Kiểm tra tự động hóa có thể được thực hiện thông qua Runner cả collection. Điều này sẽ được thảo luận thêm trong bài học tiếp theo.
4. Open New – Mở một tab mới, cửa sổ Postman hoặc cửa sổ Runner bằng việc kích trên nút này.
5. My Workspace – Bạn có thể tạo sổ làm việc riêng hoặc như cho một nhóm.
6. Invite – Làm việc cộng tác với nhiều thành viên bằng việc mời các thành viên.
7. History – Các request đã thực hiện mà bạn đã thực hiện sẽ được hiển thị trong History. Giúp bạn có thể lần theo các hành động bạn đã làm.
8. Collections – Tổ chức bộ thử nghiệm của bạn bằng cách tạo collection. Mỗi collection có thể có các thư mục con và nhiều yêu cầu. Request hoặc thư mục cũng có thể được trùng lặp.
9. Tab Request – Hiển thị tiêu đề của requet mà bạn đang làm việc. Mặc định “Untitled Request” sẽ được hiển thị cho các request không có tiêu đề.
10. HTTP Request – Click vào đây sẽ hiển thị danh sách thả xuống với các request khác nhau như GET, POST, COPY, DELETE, v.v. Trong thử nghiệm, các yêu cầu được sử dụng phổ biến nhất là GET và POST.
11. Request URL – Còn được gọi là điểm cuối (endpoint), đây là nơi bạn sẽ xác định liên kết đến nơi API sẽ giao tiếp.
12. Save – Nếu có thay đổi đối với request, nhấp vào Save là bắt buộc để những thay đổi mới sẽ không bị mất hoặc bị ghi đè.
13. Params – Đây là nơi bạn sẽ viết các tham số cần thiết cho một request, ví dụ như các cặp key – value.
14. Authorization – Để truy cập API, cần được cấp quyền. Nó có thể ở dạng tên người dùng và mật khẩu, bearer token, v.v.
15. Headers – Bạn có thể thiết lập các header như nội dung kiểu JSON tùy theo cách tổ chức của bạn.
16. Body – Đây là nơi chúng ta có thể tùy chỉnh chi tiết trong request thường được sử dụng trong request POST.
17. Pre-request Script – Đây là các tập lệnh sẽ được thực thi trước request. Thông thường, script tiền request (pre-request) cho cài đặt môi trường được sử dụng để đảm bảo các kiểm tra sẽ được chạy trong môi trường chính xác.
18. Tests – Đây là các script được thực thi khi request. Điều quan trọng là phải có các thử nghiệm như thiết lập các điểm checkpoint để kiểm tra trạng thái là ok, dữ liêu nhận được có như mong đợi không và các thử nghiệm khác.

Làm việc với Request GET

Request GET được sử dụng để truy vấn thông tin từ truyền vào trên URL. Điều này sẽ không làm thay đổi gì với endpoint.

Chúng ta sẽ sử dụng URL bên dưới cho các ví dụ trong bài này:

https://jsonplaceholder.typicode.com/users		

Trong workspace

1. Thiết lập request HTTP của bạn là GET.
2. Trong trường URL yêu cầu, nhập vào link
3. Kích nút Send
4. Bạn sẽ nhìn thấy message 200 OK
5. Sẽ hiển thị kết quả 10 người dùng trong phần Body của bạn

*Chú ý: Có thể có nhiều trường hợp request GET không thành công. Nó có thể thể do URL của request không hợp lệ hoặc do chứng thực không thành công (authentication).

Làm việc với Request POST

Post requests are different from Get request as there is data manipulation with the user adding data to the endpoint. Using the same data from the previous tutorial in Get request, let’s now add our own user.

Bước 1) Kích dấu + để thêm mới một tab cho request mới.

Bước 2) Trong tab mới

1. Thiết lập request HTTP là POST.
2. Nhập vào link với url: https://jsonplaceholder.typicode.com/users
3. Chuyển tới tab Body

Bước 3) Trong tab Body,

1. Kích chọn raw
2. Chọn JSON

Bước 4) Copy và paste chỉ một user từ kết quả request trước như bên dưới. Đảm bảo rằng mã đã được sao chép chính xác với các dấu đóng mở. Thay đổi id thành 11 và đặt name bất kỳ tên nào bạn muốn. Bạn cũng có thể thay đổi các trường khác như address.

[
    {
        "id": 11,
        "name": "Krishna Rungta",
        "username": "Bret",
        "email": "Sincere@april.biz",
        "address": {
            "street": "Kulas Light",
            "suite": "Apt. 556",
            "city": "Gwenborough",
            "zipcode": "92998-3874",
            "geo": {
                "lat": "-37.3159",
                "lng": "81.1496"
            }
        },
        "phone": "1-770-736-8031 x56442",
        "website": "hildegard.org",
        "company": {
            "name": "Romaguera-Crona",
            "catchPhrase": "Multi-layered client-server neural-net",
            "bs": "harness real-time e-markets"
        }
    }
]

*Chú ý: Request POST nên đúng định dạng để đảm bảo dữ liệu được yêu cầu sẽ được tạo. Kinh nghiệm để check dữ liệu JSON đúng định dang hay không, bạn có thể sử dụng tool như: https://jsonformatter.curiousconcept.com/

Bước 5) Tiếp theo,

1. Kích nút Send.
2. Status: 201 Created được hiển thị
3. Dữ liệu Post được hiển thị trong tab Body.

Các thiết lập các tham số Request

Tham số hóa dữ liệu là một trong những tính năng hữu ích nhất của Postman. Để tạo cùng một request với dữ liệu khác nhau, bạn có thể sử dụng các biến với tham số. Những dữ liệu này có thể từ một tệp dữ liệu hoặc một biến môi trường. Tham số hóa giúp tránh lặp lại các thử nghiệm tương tự và lặp lại có thể được sử dụng để kiểm thử tự động.

Các tham số được tạo thông qua việc sử dụng dấu ngoặc kép: {{sample}}. Chúng ta hãy xem một ví dụ về việc sử dụng các tham số trong request trước đây:

Bây giờ hãy tạo một tham số cho request.

Bước 1)

1. Thiết lập request HTTP là GET
2. Nhập vào một link: https://jsonplaceholder.typicode.com/users. Thay thế phần đầu tiên của link bằng một biến như {{url}}. URL reques lúc này sẽ là {{url}}/users.
3. Kích nút Send.

Không nhận được kết quả nào vì chúng ta chưa đặt giá trị cho biến này.

Bước 2) Để sử dụng biến này bạn cần thiết lập môi trường

1. Kích vào biểu tượng mắt
2. Kích Edit để thiết lập biết cho sử dụng cho toàn cục mà sẽ được sử dụng trong tất cả các collection.

Bước 3) Chọn biến,

1. Thiết lập tên url: https://jsonplaceholder.typicode.com
2. Kích nút Save.

Bước 4) Kích Close nếu bạn muốn đóng màn hình này

Bước 5) Trở lại request GET và kích nút Send. Bạn sẽ nhìn thấy kết quả cho request của bạn.

*Chú ý: Luôn đảm bảo rằng các tham số của bạn có dữ liệu như một biến môi trường hoặc một file để tránh bị lỗi.

Để tạo các Test trong Postman

Postman Tests là code JavaScript được thêm vào các request để giúp bạn kiểm tra kết quả như trạng thái thành công hay thất bại, so sánh với các kết quả dự kiến, v.v. Nó thường bắt đầu với pm.test. Thường được so sánh với các giá trị khác, kiểm tra các câu lệnh có sẵn trên các công cụ khác.

Hãy tạo một vài test đơn giản cho các request tham số từ các ví dụ trước.

Bước 1) Tới request GET của bạn từ ví dụ trước.

1. Chuyển sang tab Tests, nằm bên tay phải của cửa sổ code.
2. Từ mục Code, kích vào “Status code: Code is 200”.

Cửa sổ được tự động điền như bên dưới.

Bước 2) Giờ kích nút Send. Kết quả test sẽ được hiển thị.

Bước 3) Quay lại  tab Tests và thêm một test khác. Bây giờ chúng ta sẽ so sánh kết quả dự kiến với kết quả thực tế.

Từ phần Code, kích trên “Response body:JSON value check”. Chúng ta sẽ kiểm tra nếu người dùng “Leanne Graham” có userid là 1.

Bước 4)

1. Thay thế “Your Test Name” từ code tự sinh bằng “Check if user with id1 is Leanne Graham” mà tên test sẽ hiển thị chính xác như vậy.
2. Thay thế jsonData.value thành jsonData[0].name. Để kiểm tra được, lấy giá trị của userid đầu tiên (bắt đầu bởi chỉ số 0) và truy cập vào thuộc tính name để lấy tên của user.
3. Sử dụng toán tử eql, nhập vào “Leanne Graham”

pm.test("Check if user with id1 is Leanne Graham", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData[0].name).to.eql("Leanne Graham");
});

Bước 5) Kích nút Send. Bây giờ sẽ có hai kết quả kiểm tra cho request của bạn.

*Chú ý: Có nhiều loại test khác có thể được tạo ra trong Postman. Hãy thử khám phá công cụ và xem thử nghiệm nào sẽ phù hợp với nhu cầu của bạn.

Cách tạo Collection

Bước 1) Kích vào nút New ở bên góc trái của trang.

Bước 2) Chọn Collection. Cửa sổ tạo Collection hiển thị ra.

Bước 3) Nhập vào tên Collection và mô tả rồi kích nút Create. Một collection lúc này sẽ được taọ.

Bước 4) Trở lại requets GET phần trước, kích nút Save

Bước 5)

1. Chọn Postman Test Collection.
2. Kích nút Save to Postman Test Collection

Bước 6) Postman test collection bây giờ sẽ chứa một request.

Bước 7) Lặp lại Bước 4-5 cho request POST phần trước. Collection bây giờ sẽ có hai request.

Cách chạy Collection sử dụng Runner

Có hai cách để chạy một collection đó là sử dụng Collection Runner và  Newman. Hãy bắt đầu thực thi collection bằng Collection Runner.

Bước 1) Kích trên nút Runner ở góc trên bên cạch nút Import.

Bước 2) Trang Collection Runner sẽ xuất hiện như ở bên dưới. Theo các mô tả ở các trường bên dưới.

Bước 3) Chạy Postman Test Collection bằng cách thiết lập sau:

• Chọn Postman test collection- Thiết lập Iterations là 3
• Thiết lập Delay là 2500 ms
• Kích nút Run Postman Test…

Bước 4) Trang kết quả chạy sẽ được hiển thị sau hi kích nút Run. Phụ thuộc và delay, bạn sẽ nhìn thấy kết quả mà chúng thực hiện.

1. Khi test kết thúc, bạn có thể nhìn thấy trạng thái nếu nó Passed hoặc Failed và kết quả mỗi lần lặp (iteration).
2. Bạn nhìn thấy trạng thái Pass cho các request GET
3. Khi chúng ta không có bất kỳ thử nghiệm nào cho POST, sẽ có một message hiển thị “This request did not have any tests”.

Bạn có thể thấy tầm quan trọng của việc có các test trong các requesst để bạn có thể xác minh trạng thái HTTP nếu thành công và dữ liệu được tạo hoặc truy xuất.

Cách chạy Collection sử dụng Newman

Một cách khác để chạy collection là theo hướng Newman. Sự khác nhau chính của Newman và Collection Runner là:

1. Newman là một add-on cho Postman. Bạn sẽ cần cài riêng từ App Native.
2. Newman sử dụng dòng lệnh để chạy trong khi Collection Runner có giao diện đồ hoạ (GUI).
3. Newman có thể được sử dụng cho tích hợp liên tục.

Để cài Newman và chạy collection của chúng ta, làm theo các bước:

Bước 1) Cài nodejs sử dụng link sau: http://nodejs.org/download/

Bước 2) Mở cử sổ command và nhập

 npm install -g newman

Newman sẽ được cài trên máy tính của bạn.

Bước 3) Sau khi Newman được cài đặt xong, hãy trở lại workspace của Postman. Trong hộp thoại Collections, kích vào dấu ba chấm, cửa sổ tuỳ chọn xuất hiện. Chọn Export.

Bước 4) Chọn Export Collection ví dụ như Collection v2.1 (Recommended) rồi kích Export.

Bước 5) Chọn nơi bạn sẽ lưu và kích Save.Select your desired location then click Save. Khuyến khích tạo thư mục riêng cho các bài test Postman của bạn. Một collection nên được export sang thư mục cục bộ trên máy bạn.

Bước 6) Chúng ta cũng cần export môi trường của chúng ta. Kích trên biểu tượng mắt, một danh sách đổ xuống, trong Global, chọn Download as JSON. Chọn nơi bạn muốn lưu và kích Save. Khuyến khích nên lưu các thông số môi trường trong cùng thư mục với collection của bạn.

Bước 7) Các biến môi trường nên được export cùng thư mục với Collection.

Bước 8) Bây giờ qua lại cửa sổ dòng lệnh, thay đổi thư mục mà bạn đã lưu Collection và các biến môi trường, ví dụ như:

 cd C:\Users\Asus\Desktop\Postman Tutorial

Bước 9) Chạy collection của bạn sử dụng dòng lệnh sau:

 newman run PostmanTestCollection.postman_collection.json -e Testing.postman_globals.json

Chạy kết quả sẽ hiển thị như bên dưới:

Hướng dẫn tham chiếu một số dòng code cơ bản cho chạy Newman:

1. Chỉ chạy collection. Dùng cho trường hợp không có biến môi trường hoặc dữ liệu file test độc lập

newman run <collection name>

2. Chạy với một collection và biến môi trường. Tham số -e chỉ thị cho môi trường.

newman run <collection name> -e <environment name>

3. Chạy collection với số lần lặp lại (iteration)

newman run <collection name> -n <no.of iterations>

4. Chạy với file dữ liệu

newman run <collection name> --data <file name>  -n <no.of iterations> -e <environment name>

5. Thiết lập thời gian delay. Điều này rất quan trọng vì các test có thể thất bại nếu nó được chạy không có delay do các request được bắt đầu mà không đợi các request trước đó hoàn thành xử lý trên endpoint server.

newman run <collection name> -d <delay time>

Tổng kết

• Postman là một trong những công cụ phổ biến nhất được sử dụng trong thử nghiệm API
• Khả năng truy cập, Sử dụng Bộ sưu tập, Cộng tác, Tích hợp liên tục, là một số tính năng chính cần tìm hiểu Postman
• Bạn nên tạo một tài khoản trong Postman, vì vậy các collection của bạn có sẵn trực tuyến
• Bạn có thể tham số hoá request trong Postman
• Bạn có thể tạo các Test để kiểm tra các request trong Postman
• Các collection có thể được chạy bằng Newman hoặc Runner trong Postman