5. Postman tool
Cài đặt Postman trên máy tính
- Truy cập vào trang chủ của Postman tại https://www.postman.com/downloads.
- Chọn phiên bản phù hợp với hệ điều hành của bạn và tải xuống file cài đặt.
- Sau khi tải xuống, mở file cài đặt và bắt đầu quá trình cài đặt bằng cách nhấn vào nút "Install".
- Sau khi cài đặt thành công, mở Postman bằng cách tìm kiếm trong danh sách ứng dụng hoặc chọn biểu tượng Postman trên màn hình Desktop.
- Sau khi cài đặt thành công, bạn có thể bắt đầu sử dụng Postman để gửi các yêu cầu HTTP, kiểm thử API, chạy các bộ kiểm thử tự động và quản lý các biến và môi trường. Bạn có thể tham khảo tài liệu hướng dẫn và tài nguyên trên trang chủ của Postman để biết thêm thông tin chi tiết về cách sử dụng Postman.
Thực hành với POSTMAN
Đăng nhập để lấy access_token
- Url: https://server.aptech.io/auth/login
- Method: POST
- Body: (RAW -> JSON):
{
"username": "tungnt@softech.vn",
"password": "123456789"
}
- Response:
{
"loggedInuser": {
"id": 1,
"email": "tungnt@softech.vn",
"isActive": true,
"userRoles": [
...
]
},
"access_token": "...",
"refresh_token": "..."
}
Sử dụng access_token để gọi các API khác
Gắn access_token vào các request có yêu cầu xác thực
- Chọn tab Auth
- Chọn Type: Bearer Token
- Dán access_token từ [response body] của [login request] vào ô token
Send GET request
Để gọi một GET request trong Postman, làm theo các bước sau:
- Mở Postman lên và tạo một bộ sưu tập mới hoặc chọn một bộ sưu tập hiện có để thêm một yêu cầu mới.
- Chọn phương thức "GET" và nhập URL của API endpoint mà bạn muốn gửi yêu cầu POST.
- Nhấn vào nút "Send" để gửi yêu cầu GET. Postman sẽ gửi yêu cầu tới địa chỉ URL mà bạn đã nhập và chờ nhận phản hồi từ server.
- Sau khi Postman nhận được phản hồi từ server, nó sẽ hiển thị kết quả trả về trong cửa sổ "Response" bên dưới. Bạn có thể xem mã trạng thái của phản hồi, thông tin tiêu đề và thân phản hồi.
Nếu request yêu cầu xác thực, bạn cần phải gửi access_token trong header của request. Hướng dẫn:
- Chọn tab Auth
- Chọn Type: Bearer Token
- Dán access_token từ [response body] của [login request] vào ô token
Ví dụ:
- Url: https://server.aptech.io/online-shop/categories
- Method: GET
- Response status
- 200: OK
Send GET request with query params
Để gọi một GET request trong Postman để lấy thông tin của một category có ID là 7, làm theo các bước sau:
- Mở Postman lên và tạo một bộ sưu tập mới hoặc chọn một bộ sưu tập hiện có để thêm một yêu cầu mới.
- Chọn phương thức "GET" và nhập URL của API endpoint mà bạn muốn gửi yêu cầu GET để lấy thông tin category. Ví dụ: https://server.aptech.io/online-shop/categories/7 để lấy thông tin category có ID là 7.
- Nhấn vào nút "Send" để gửi yêu cầu GET. Postman sẽ gửi yêu cầu tới địa chỉ URL mà bạn đã nhập và chờ nhận phản hồi từ server.
- Sau khi Postman nhận được phản hồi từ server, nó sẽ hiển thị kết quả trả về trong cửa sổ "Response" bên dưới. Bạn có thể xem mã trạng thái của phản hồi, thông tin tiêu đề và thân phản hồi.
Nếu request yêu cầu xác thực, bạn cần phải gửi access_token trong header của request. Hướng dẫn:
- Chọn tab Auth
- Chọn Type: Bearer Token
- Dán access_token từ [response body] của [login request] vào ô token
Ví dụ:
- Url: https://server.aptech.io/online-shop/categories/7
- Method: GET
- Response status: 200
Send POST request
Đ ể gọi một POST request trong Postman, làm theo các bước sau:
- Mở Postman lên và tạo một bộ sưu tập mới hoặc chọn một bộ sưu tập hiện có để thêm một yêu cầu mới.
- Chọn phương thức "POST" và nhập URL của API endpoint mà bạn muốn gửi yêu cầu POST.
- Chọn tab "Body" trong Postman và chọn loại định dạng dữ liệu mà bạn muốn gửi. Ví dụ: Raw, JSON, x-www-form-urlencoded, hay form-data.
- Nhập dữ liệu của yêu cầu trong phần thân yêu cầu (request body). Nếu bạn chọn "Raw", bạn có thể nhập dữ liệu trực tiếp vào ô văn bản, hoặc nếu bạn chọn một loại định dạng khác như JSON hoặc form-data, bạn có thể sử dụng các ô đầu vào để thêm dữ liệu.
- Nhấn vào nút "Send" để gửi yêu cầu POST. Postman sẽ gửi yêu cầu tới địa chỉ URL mà bạn đã nhập và chờ nhận phản hồi từ server.
- Sau khi Postman nhận được phản hồi từ server, nó sẽ hiển thị kết quả trả về trong cửa sổ "Response" bên dưới. Bạn có thể xem mã trạng thái của phản hồi, thông tin tiêu đề và thân phản hồi.
Nếu request yêu cầu xác thực, bạn cần phải gửi access_token trong header của request. Hướng dẫn:
- Chọn tab Auth
- Chọn Type: Bearer Token
- Dán access_token từ [response body] của [login request] vào ô token
Ví dụ:
-
Method: POST
-
Body (Raw -> JSON)
{
"name": "New Product",
"description": "New Desc"
} -
Response status
- 201: Created
- 500: Internal Server Error
Send PATCH request
Để gọi một PATCH request trong Postman, làm theo các bước sau:
- Mở Postman lên và tạo một bộ sưu tập mới hoặc chọn một bộ sưu tập hiện có để thêm một yêu cầu mới.
- Chọn phương thức "PATCH" và nhập URL của API endpoint mà bạn muốn gửi yêu cầu PATCH. Ví dụ: https://server.aptech.io/online-shop/categories/1 để cập nhật thông tin category có ID là 1.
- Chọn tab "Body" trong Postman và chọn loại định dạng dữ liệu mà bạn muốn gửi. Ví dụ: Raw, JSON, x-www-form-urlencoded, hay form-data.
- Nhập dữ liệu của yêu cầu trong phần thân yêu cầu (request body). Nếu bạn chọn "Raw", bạn có thể nhập dữ liệu trực tiếp vào ô văn bản, hoặc nếu bạn chọn một loại định dạng khác như JSON hoặc form-data, bạn có thể sử dụng các ô đầu vào để thêm dữ li ệu.
- Nhấn vào nút "Send" để gửi yêu cầu PATCH. Postman sẽ gửi yêu cầu tới địa chỉ URL mà bạn đã nhập và chờ nhận phản hồi từ server.
- Sau khi Postman nhận được phản hồi từ server, nó sẽ hiển thị kết quả trả về trong cửa sổ "Response" bên dưới. Bạn có thể xem mã trạng thái của phản hồi, thông tin tiêu đề và thân phản hồi.
Nếu request yêu cầu xác thực, bạn cần phải gửi access_token trong header của request. Hướng dẫn:
- Chọn tab Auth
- Chọn Type: Bearer Token
- Dán access_token từ [response body] của [login request] vào ô token
Ví dụ:
-
Method: PATCH
-
Parmas: id = 1
-
Body (Raw -> JSON)
{
"description": "New Desc"
} -
Response status
- 200: Cập nhật thành công
- 400: id không hợp lệ
- 410: Không tìm thấy category
Send DELETE request
Để gọi một DELETE request trong Postman để xóa một category có id = 34, làm theo các bước sau:
- Mở Postman lên và tạo một bộ sưu tập mới hoặc chọn một bộ sưu tập hiện có để thêm một yêu cầu mới.
- Chọn phương thức "DELETE" và nhập URL của API endpoint mà bạn muốn gửi yêu cầu DELETE để xóa category. Ví dụ: https://server.aptech.io/online-shop/categories/34 để xóa category có ID là 34.
- Nhấn vào nút "Send" để gửi yêu cầu DELETE. Postman sẽ gửi yêu cầu tới địa chỉ URL mà bạn đã nhập và chờ nhận phản hồi từ server.
- Sau khi Postman nhận được phản hồi từ server, nó sẽ hiển thị kết quả trả về trong cửa sổ "Response" bên dưới. Bạn có thể xem mã trạng thái của phản hồi, thông tin tiêu đề và thân phản hồi.
Nếu request yêu cầu xác thực, bạn cần phải gửi access_token trong header của request. Hướng dẫn:
- Chọn tab Auth
- Chọn Type: Bearer Token
- Dán access_token từ [response body] của [login request] vào ô token
Ví dụ:
- Url: https://server.aptech.io/online-shop/categories/34
- Method: DELETE
- Param: id = 34
- Response status:
- 200: Xóa thành công
- 400: id không hợp lệ
- 410: Không tìm thấy category