Postman - Cách sử dụng Postman để kiểm tra API (Phần 1)

Postman, Test API

Postman là gì?

Postman là một công cụ cho phép chúng ta thao tác với API, phổ biến nhất là REST. Postman hiện là một trong những công cụ phổ biến nhất được sử dụng để kiểm tra API, với postman chúng ta có thể gọi Rest API mà không cần viết dòng code nào.

Postman được bắt đầu phát triển vào năm 2012 như một dự án phụ của Abhinav Asthana nhằm đơn giản hóa quy trình làm việc của API trong thử nghiệm và phát triển. API là viết tắt của Application Programming Interface 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 lại sử dụng Postman

Với hơn 4 triệu người 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:

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 mình để dễ dàng truy cập tệp mọi lúc, mọi nơi miễn là có ứng dụng Postman trên máy tính
Sử dụng 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. Điều này giúp tổ chức các bộ thử nghiệm một các dễ dàng.
Cộng tác - Các bộ sưu tập và môi trường có thể được nhập hoặc xuất, nó giúp dễ dàng chia sẻ tệp. Một liên kết trực tiếp cũng có thể được sử dụng để chia sẻ bộ sưu tập
Tạo môi trường - Có nhiều môi trường giúp kiểm tra ít lặp lại hơn vì người ta 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.
Tạo tests - Các test checkpoint 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, Postman giúp đảm vào phạm vi kiểm tra đó.
Kiểm tra tự động hóa - Thông qua việc sử dụng Collection Runner hoặc Newman, các bài kiểm thử có thể được chạy nhiều lần lặp lại, tiết kiệm thời gian cho các bài kiểm tra lặp lại.
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 các bài kiểm tra.
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 phương pháp phát triển được duy trì.

Cách tải xuống và cài đặt Postman

Là một công cụ mã nguồn mở, nó có thể dễ dàng tải xuống. Dưới đây là các bước để cài đặt:

Bước 1: Truy cập https://www.postman.com/downloads/ và chọn nền tảng mong muốn của bạn trong số Mac, Windows hoặc Linux. Click vào "Download" để tải xuống.

Bước 2: Thông báo đang trong quá trình tải xuống của bạn sẽ hiển thị trên trạng ứng dụng. Sau khi hoàn tất quá trình tải xuống, hãy click vào "Run".

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

Bước 4: Tại màn hình, đăng ký tài khoản để sử dụng Postman

Lưu ý: Có hai cách để đăng ký tài khoản Postman. Một là tạo tài khoản Postman của riêng mình, hai là 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ý giúp đảm bảo rằng bộ sưu tập của bạn sẽ được lưu và có thể truy cập được để sử dụng sau này.

Bước 5: Chọn công cụ workspace mà bạn cần và click vào "Lưu" để lưu tùy chọn.

Bước 6: Bạn sẽ thấy màn hình khởi động

Cách sử dụng Postman để thực thi các API

Dưới đây là màn hình làm việc của Postman. Hãy cùng khám phá quy trình từng bước về cách sử dụng Postman và các tính năng khác của công cụ Postman!

Giải thích các vị trí đánh dấu trên màn hình:

New - Đây là nơi bạn sẽ tạo một yêu cầu, bộ sưu tập hoặc môi trường mới.
Import - Được sử dụng để nhập một bộ sưu tập hoặc môi trường. Có các tùy chọn như nhập từ tệp, thư mục, liên kết hoặc dán văn bản thô.
Runner - Các bài kiểm tra tự động hóa có thể được thực hiện thông qua Collection Runner.
Open New - Mở tab mới, Postman Window hoặc Runner Window bằng cách click vào button.
My Workspace - Bạn có thể tạo workspace mới riêng lẻ hoặc theo nhóm
Invite - Cộng tác trên workspace bằng cách mời thành viên trong nhóm
History - Các yêu cầu trước đây mà bạn đã gửi sẽ được hiển thị trong History. Điều này giúp bạn dễ dạng theo dõi các hành động bạn đã thực hiện.
Collections - Tổ chucs bộ kiểm thử bằng các tạo bộ sưu tập. Mỗi bộ sưu tập có thể có các thư mục con và nhiều yêu cầu. Một yêu cầu hoặc thư mục cũng có thể được sao chép.
Request tab - Tab này hiển thị tiêu đề của yêu cầu bạn đang thực hiện. Theo mặc định, "Untitled Request" sẽ được hiển thị cho các yêu cầu không có tiêu đề.
HTTP Request - Nhấp vào đây sẽ hiển thị danh sách thả xuống gồm yêu cầu khác nhau như GET, POST, COPY, DELETE, v, v. Trong kiểm thử API, các phương thức thường được sử dụng nhất là GET và POST.
Request URL - Còn được gọi là điểm cuối, đây là nơi bạn sẽ xác định liên kết đến nơi API sẽ giao tiếp.
Save - Nếu có các thay đổi đối với một yêu cầu, việc nhấp vào lưu là điều bắt buộc để các thay đổi mới không bị mất hoặc bị ghi đè
Params - Đây là nơi bạn sẽ viết các tham số cần thiết cho một yêu cầu như giá trị khóa.
Authorization - Để truy cập API, cần có ủy quyền thích hợp. Nó có thể ở dạng tên người và mật khẩu, mã thông báo mang tên, v.v.
Headers - Bạn có thể đặt tiêu đề như kiểu nội dung JSON tùy thuộc vào như cầu của tổ chức.
Body - Đây là nơi người ta có thể tùy chỉnh các chi tiết trong một yêu cầu thường được sử dụng trong phường thức POST
Pre-request Script - Đây là những tập lệnh sẽ được thực thi trước yêu cầu. Thông thường các tập lệnh yêu cầu trước cho môi trường cài đặt được sử dụng để đảm bảo rằng các thử nghiệm sẽ được chạy trong môi trường chính xác.
Tests - Đây là những tập lệnh được thực thi trong quá trình yêu cầu. Điều quan trọng là phải có các bài kiểm tra vì nó thiết lập các điểm kiểm tra để xác minh xem trạng thái phản hồi có ổn không, dữ liệu được truy xuất có như mong đợi hay không và các bài kiểm tra khác.

Làm việc với phương thức GET

Phương thức GET được sử dụng để truy cập thông tin từ URL đã cho. Sẽ không có thay đổi nào được thực hiện đối với điểm cuối.

Chúng ta sẽ sử dụng URL sau cho tất cả các ví trụ trong hướng dẫn này

https://jsonplaceholder.typicode.com/users

Trong workspace

1. Cài đặt phương thức là GET
2. Nhập link vào ô request URL
3. Click "Send"
4. Bạn sẽ thấy 200 thông báo OK

5. Phải có 10 kết quả của người dùng trong phần nội dung cho biết rằng kiểm thử của bạn đã chạy thành công.

Lưu ý: Có thể có trường hợp yêu cầu GET không thành công, Có thể do URL yêu cầu không hợp lệ hoặc cần xác thực

Làm việc với phương thức POST

Phương thức POST khác với GET vì cần có thao tác dữ liệu với việc người dùng thêm dữ liệu vào điểm cuối. Sử dụng cùng một dữ liệu từ hướng dẫn trước trong GET, bây giờ chugns ta hãy thêm người dùng của riêng mình.

Bước 1: Click vào "New tab" để tạo yêu cầu mới

Bước 2: Tại New tab

1. Cài đặt phương thức là POST
2. Nhập cùng một liên kết trong request URL
https://jsonplaceholder.typicode.com/users

3. Mở tab Body

Bước 3: Tại Body
1. Click "raw"

2. Chọn JSON

Bước 4: Chỉ copy và paste một kết quả người dùng từ yêu cầu nhận 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 ngoặc nhọn và dấu ngoặc nhọn được ghéo nối. Thay đổi id thành 11 và đặt tên thành bất kỳ tên nào bạn muộn. Bạn cũng có thể thay đổi các chi tiết khác như địa chỉ.

[
    {
        "id": 11,
        "name": "Krishna Rungta",
        "username": "Bret",
        "email": "[email protected]",
        "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"
        }
    }
]

Lưu ý: Yêu cầu POST online phải có định dạng chính xác để đảm bảo rằng dữ liệu được yêu cầu sẽ được tạo. Bạn nên sử dụng GET trước để kiểm tra định dạng JSON của yêu cầu.

Bước 5: Tiếp theo
1. Click "Send"
2. Trạng thái: 201 đã tạo nên được hiển thị

3. Dữ liệu post đã được hiển thị trong phần nội dung

Cách tham số hóa các yêu cầu

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. Thay vì tạo các yêu cầu giống nhau với các dữ liệu khác nhau, bạn có thể sử dụng các biến có 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. Việc tham số hóa giúp tránh lặp lại các kiểm thử giống nhau và các bước lặp lại có thể được sử dụng để kiểm thử tự động hóa.

Các tham số được tạo thông qua việc sử dụng dấu ngoặc nhọn kép: {{sample}}. Hãy xem một ví dụ về việc sử dụng các tham số trong yêu cầu trước của tôi:

Bây giờ, hãy tạo một yêu cầu nhận tham số.

Bước 1:
1. Cài đặt phương thức là GET
2. Nhập vào link: https://jsonplaceholder.typicode.com/users.
Thay thế phần đầu tiên của liên kết bằng một tham số như {{url}}. URL yêu cầu bây giờ phải là {{url}}/ người dùng.
3. Click "Send"

Sẽ không có phản hồi vì chúng ta chưa đặt nguồn tham số của mình.

Bước 2: Để sử dụng tham số, bạn cần thiết lập môi trường
1. Click biểu tượng mắt

2. Nhập vào chỉnh sửa để đặt biến thành môi trường chung có thể được sử dụng trong tất cả các bộ sưu tập.

Bước 3: Nhập vào giá trị hợp lệ
1. Đặt tên cho url là https://jsonplaceholder.typicode.com

2. Click "Save"

Bước 4: Click vào đóng nếu bạn nhìn thấy màn hình tiếp theo

Bước 5: Quay lại phương thức GET, sau đó nhấp vào gửi. Bây giờ sẽ có kết quả cho yêu cầu của bạn

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

Tổng kết

Trong bài viết này chúng ta đã cùng tìm hiểu về Postman là gì, tại sao lại cần sử dụng Postman, cách cài đặt postman và sử dụng GET và POST trong Posman. Bài tiếp theo chúng ta sẽ tìm hiểu cách tạo các bài kiểm thử trong Postman, làm thể nào để tạo bộ sưu tập, cách chạy bộ sưu tập bằng Collection Runner và Newman.

Nguồn tham khảo: https://www.guru99.com/postman-tutorial.html