Phân biệt Request, Response trong api
Request và Response là hai phần quan trọng trong giao tiếp giữa client (máy khách) và server (máy chủ) khi sử dụng một API (Application Programming Interface). Dưới đây là giải thích chi tiết về API request và API response
1. API Request (Yêu cầu API)
API Request là thông điệp mà Client gửi đến Server để yêu cầu một hành động hoặc dịch vụ nào đó. Mục đích của yêu cầu API là yêu cầu server thực hiện một thao tác (ví dụ: lấy dữ liệu, gửi dữ liệu, hoặc cập nhật tài nguyên). Các thành phần cơ bản trong một API Request bao gồm:
Các thành phần trong API Request:
- HTTP Method (Phương thức HTTP): Phương thức HTTP cho biết loại hành động mà client muốn thực hiện trên tài nguyên (resource). Các phương thức phổ biến bao gồm:
- GET: Lấy dữ liệu từ server.
- POST: Gửi dữ liệu mới lên server (thường dùng để tạo tài nguyên mới).
- PUT: Cập nhật tài nguyên hiện có (thay thế hoàn toàn tài nguyên).
- PATCH: Cập nhật một phần tài nguyên.
- DELETE: Xóa tài nguyên.
- URL (Uniform Resource Locator): URL là địa chỉ tài nguyên trên server mà bạn muốn tương tác với.
Ví dụ: /api/products hoặc /api/users/123.
- Headers (Tiêu đề): Headers chứa thông tin bổ sung về yêu cầu, ví dụ như loại dữ liệu mà client sẽ gửi hoặc nhận, thông tin xác thực,…. Một số headers phổ biến:
- Content-Type: Xác định loại dữ liệu mà client gửi, ví dụ: application/json.
- Authorization: Thông tin xác thực (API Key, Token, …).
- Accept: Xác định loại dữ liệu mà client mong muốn nhận từ server
- Query Parameters (Tham số truy vấn): Tham số truy vấn là các giá trị bổ sung mà client gửi trong URL để tinh chỉnh yêu cầu. Chúng xuất hiện sau dấu ? và được phân cách bằng dấu &.
Ví dụ: /api/products?category=electronics&page=2.
- Request Body (Nội dung yêu cầu): Phần này thường có trong các phương thức như POST, PUT, PATCH khi bạn cần gửi dữ liệu đến server. Nội dung này có thể là JSON, XML hoặc các định dạng khác.
2. API Response (Phản hồi API)
2.1 HTTP Status Code (Mã trạng thái HTTP): Mã trạng thái HTTP cho biết kết quả của yêu cầu. Các mã trạng thái chính bao gồm:
- 2xx (Thành công):
- 200 OK: Yêu cầu thành công và trả về dữ liệu.
- 201 Created: Tài nguyên đã được tạo thành công (thường cho POST).
- 4xx (Lỗi phía client):
- 400 Bad Request: Yêu cầu không hợp lệ (ví dụ: thiếu tham số).
- 401 Unauthorized: Yêu cầu không có quyền truy cập (ví dụ: thiếu token xác thực).
- 404 Not Found: Tài nguyên yêu cầu không tìm thấy.
- 5xx (Lỗi phía server):
- 500 Internal Server Error: Lỗi không xác định từ phía server.
2.2 Headers (Tiêu đề phản hồi): Các headers trong phản hồi chứa thông tin bổ sung về dữ liệu trả về hoặc các chi tiết khác:
- Content-Type: Xác định kiểu dữ liệu trả về, ví dụ: application/json.
- Cache-Control: Quy định về bộ nhớ đệm (cache).
2.3 Response Body (Nội dung phản hồi): Nội dung của phản hồi, chứa dữ liệu mà server trả về cho client hoặc thông báo lỗi. Đây là phần dữ liệu chính trong phản hồi và có thể là JSON, XML, HTML, hoặc plain text.
3. So sánh giữa API Request và API Response
| Yếu tố | API Request | API Response |
| Mục đích | Gửi yêu cầu đến server để thực hiện hành động | Trả về kết quả hoặc thông báo từ server |
| Phương thức HTTP | GET, POST, PUT, DELETE, PATCH | Được xác định qua mã trạng thái HTTP (200, 404,…) |
| URL | Địa chỉ tài nguyên cần truy cập (ví dụ: /api/products/123) | Thông tin không có URL (trả về kết quả từ URL yêu cầu) |
| Body | Có thể chứa dữ liệu (như JSON, XML) trong yêu cầu POST, PUT, PATCH | Có thể chứa dữ liệu trả về (như JSON, XML) hoặc thông báo lỗi |
| Headers | Thông tin như Authorization, Content-Type, Accept | Thông tin về phản hồi, như Content-Type, Cache-Control |
| Mã trạng thái | Không có mã trạng thái (chỉ là yêu cầu) | Mã trạng thái HTTP (200, 404, 500,….) |
| Ví dụ | GET /api/products/123 | HTTP/1.1 200 OK và dữ liệu sản phẩm |
Kết Luận
- Request (Yêu cầu) là thông điệp mà client gửi đến server để yêu cầu thực hiện một hành động (lấy dữ liệu, tạo tài nguyên,…).
- Response (Phản hồi) là kết quả mà server trả về sau khi xử lý yêu cầu, có thể là dữ liệu hoặc thông báo lỗi.
Cả hai đều có các thành phần quan trọng là cặp tương tác cơ bản giữa client và server trong môi trường web và các ứng dụng phân tán, tạo nên cơ chế giao tiếp chính cho các hệ thống API
