Method API là một thành phần của request gọi từ client tới server để yêu cầu server thực hiện một việc gì đó như là lấy dữ liệu từ server về, gửi dữ liệu lên server để xử lý, cập nhật hoặc xóa dữ liệu trên server…Trên thực tế HTTP request có tất cả 9 loại method. Tuy nhiên dưới đây là các method hay dùng nhất:
- POST – Create: Tạo dữ liệu mới
- GET – Read: Lấy dữ liệu về
- PUT / PATH – Update: Cập nhật dữ liệu
- DELETE – Delete: Xóa dữ liệu
Quy tắc dùng các Method:
# | Method | URL | Explanation |
1 | GET | / | Get infor from server – no body |
2 | POST | /object | Create a new object – has body |
3 | PUT | /object/{id} | Edit an object info – has body |
4 | PATCH | /object/{id} | Edit an object info – has body |
5 | DELETE | /object/{id} | Delete an object – no body |
Lưu ý:
- Có rất nhiều API sử dụng POST thay cho PUT/ PATH. Về bản chất PUT/ PATH cũng là tạo dữ liệu mới và đẩy lên vì thế chúng ta có thể dùng POST thay PUT/ PATH ở API gọi update. Tuy nhiên tuyệt đối đừng thay thế POST bằng PUT/ PATH.
- Sự khác biệt giữa PUT và PATCH:
- PUT: Cập nhật toàn bộ thông tin của resource. Cần gửi dữ liệu của các trường thông tin trong resource (các trường có update hoặc không). Không nên chỉ gửi dữ liệu của các trường cần thay đổi vì các trường không được gửi sẽ bị xóa.
- Resource đang tồn tại: Cập nhật toàn bộ thông tin của resource bằng thông tin mới.
- Resource không tồn tại: Tạo ra 1 resource mới.
- PATCH: Cập nhật 1 phần thông tin của resource. Chỉ cần gửi dữ liệu mới của các trường cần thay đổi hoặc bổ sung, các trường không được gửi sẽ không bị thay đổi hoặc bị xóa.
- PUT: Cập nhật toàn bộ thông tin của resource. Cần gửi dữ liệu của các trường thông tin trong resource (các trường có update hoặc không). Không nên chỉ gửi dữ liệu của các trường cần thay đổi vì các trường không được gửi sẽ bị xóa.