Postman là gì? Gọi API dễ dàng với Postman

1. 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 trong thử nghiệm các API. Với Postman, ta có thể gọi Rest API mà không cần viết dòng code nào.

Postman hỗ trợ tất cả các phương thức HTTP (GET, POST, PUT, PATCH, DELETE, …). Bên cạnh đó, nó còn cho phép lưu lại lịch sử các lần request, rất tiện cho việc sử dụng lại khi cần.

2. 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ề. Truy cập 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.

3. Sử dụng Postman

Các chức năng cơ bản

• Cho phép gửi HTTP Request với các method GET, POST, PUT, DELETE.
• Cho phép post dữ liệu dưới dạng form (key-value), text, json.
• Hiện kết quả trả về dạng text, hình ảnh, XML, JSON.
• Hỗ trợ authorization (Oauth1, 2).
• Cho phép thay đổi header của các request.

Giao diện postman

1. New – tạo request, collection hoặc enviroment mới.
2. Import – 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.
4. Open New – Mở một tab mới, cửa sổ Postman hoặc cửa sổ Runner.
5. My Workspace – Tạo khu vực làm việc riêng hoặc cho một nhóm.
6. Invite – 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.

Tạo request GET

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

Trong workspace của bạn thiết lập như sau:

1. Request HTTP bạn chọn GET
2. Trường URL bạn nhập vào link: https://jsonplaceholder.typicode.com/users
3. Chọn Send
4. Kiểm tra trạng thái phản hồi, nếu là 200 OK thì request đã thành công.
5. Khi này sẽ hiển thị kết quả 10 người dùng trong phần Body của bạn.

Tạo request POST

Request post khác với request get ở chố request post có thể thao tác dữ liệu.

Bước 1: chọn dấu + để tạo thêm tab cho request mới.

Bước 2:

1. Request HTTP bạn chọn POST
2. Nhập URL với link: https://jsonplaceholder.typicode.com/users
3. Chuyển tới tab Body

Bước 3: Trong tab Body

1. Chọn Raw
2. Chuyển Text sang JSON

Bước 4:

Bạn có thể sao chép dữ liệu của 1 user từ request trước đó, đảm bảo các dấu đóng mở chính xác và thay đổi ID, Name hoặc bất kỳ trường nào bạn muốn.

Lưu ý: Để kiểm tra lại dữ liệu Json, bạn có thể sử dụng tool online như: https://jsonformatter.curiousconcept.com/

Bước 5:

1. Chọn Send
2. Kiểm tra trạng thái, nếu hiển thị 201 Created là thành công.
3. Khi này bạn sẽ thấy dữ liệu được Post hiển thị trong Body

Thiết lập các biến trong Request

Việc thiết lập các biến sẽ giúp chúng ta dễ dàng kiểm tra cùng một request với nhiều dữ liệu khác nhau trong postman. Những dữ liệu này có thể từ một tệp dữ liệu hoặc biến môi trường.

Các biến được tạo thông qua việc sử dụng dấu ngoặc kép: {{sample}}

Bây giờ hãy tạo một biến cho request GET

Bước 1:

1. Thiết lập request HTTP là GET
2. URL request lúc này sẽ là: {{url}}/users
3. Chọn Send và chờ kết quả trả về.

Khi này kết quả trả về sẽ báo lỗi do không tìm thấy biến {{url}}.

Bước 2: Thêm biến vào môi trường

1. Chọn vào biểu tượng mắt.
2. Chọn Add tại Globals để thêm biến cho Workspace hiện tại của bạn.

Bước 3: Thiết lập thông tin biến

1. Variable: tên biến, bạn cần nhập đúng tên đã điền trong dấu ngoặc kép {{}}
2. Initial value: giá trị của biến. Ở ví dụ này, chúng ta sử dụng lại link: https://jsonplaceholder.typicode.com
3. Chọn Save để lưu lại.

Bước 4: Kiểm tra kết quả.

Bạn quay lại tab request GET đã tạo trước đó, chọn Send và kiểm tra kết quả trong Body.

Tạo Collection trong Postman

Collection có vai trò quan trọng trong việc tổ chức các bộ kiểm thử. Nó có thể được import và export để dễ dàng chia sẻ các collection giữa các nhóm.

Tiến hành tạo 1 collection:

Trong Workspace của bạn, chọn Collections => Chọn dấu + để thêm mới

Khi này sẽ có tab mới hiện lên, bạn nhập tên Collection và mô tả để hoàn tất quá trình khởi tạo.

Để lưu một Request có sẵn vào Collection mới, bạn chọn Save as…

Sau đó một bản thông tin hiện lên, bạn điền tên Request và chọn Collection muốn lưu, sau đó Save

Chạy các Collection với Runner

Bước 1: Chọn Run với Collection cần chạy.

Bước 2: tại trang Runner bạn điền các thông tin sau:

• Run Order: các requests có trong Collection
• Run manually: chạy thủ công từ Collection Runner.
• Iterations: số lần chạy
• Delay: độ trễ mỗi lần chạy.

Bước 3: Chọn Run và chờ kết quả.

Kết Luận:

Bài viết trên đây cho bạn biết cách sử dụng cơ bản của postman, một công cụ rất tuyệt vời giúp cho các developer khi cần test cách truyền params hoặc kết quả respond từ API trả về.

Chúc các bạn thành công.

______________________________________________________________________________

P.A Việt Nam cung cấp đa dạng các cấu hình Máy Chủ Ảo và Máy Chủ Riêng
Cloud Server
Cloud Server Pro
Máy Chủ Riêng

Tham khảo các ưu đãi: https://www.pavietnam.vn/vn/tin-khuyen-mai/