Cách thiết kế REST API tốt hơn

 (r.bluethl.net)
26 điểm bởi xguru 2022-03-11 | 2 bình luận | Chia sẻ qua WhatsApp
  • Duy trì tính nhất quán: URL/header/xác thực/mã trạng thái..
  • Sử dụng định dạng ngày tháng ISO8601 UTC
  • Chỉ Public Endpoint là ngoại lệ không cần xác thực. Tất cả phần còn lại đều bắt buộc xác thực
  • Cung cấp Health Check Endpoint
  • Phiên bản hóa API
  • Áp dụng xác thực bằng API key
  • Sử dụng hợp lý mã trạng thái HTTP và method
  • Dùng tên ngắn gọn, có thể tự diễn giải cho từng Endpoint
  • Sử dụng phản hồi lỗi tiêu chuẩn
  • Trả về tài nguyên được tạo trong POST
  • Dùng PATCH thay vì PUT
  • Càng cụ thể càng tốt
  • Sử dụng phân trang
  • Thiết kế để mỗi tài nguyên có thể mở rộng (cho phép truyền query param như expand để cũng có thể trả về thêm thông tin)

Bài viết liên quan

2 bình luận

 
eajrezz 2022-03-14

Dạo này mình thấy nhắc đến chủ đề này khá nhiều ở nhiều nơi, nên muốn giới thiệu cuốn "Các đồ vật trong đời sống thường ngày mách cho ta về thiết kế web API". Vì tiêu đề và bìa sách nên dễ lầm tưởng đây là một cuốn sách kiểu ví von đơn giản về Internet, nhưng thực ra đây là một cuốn sách rất hay, nổi bật ở những góc nhìn sâu sắc về thiết kế API của tác giả, người đang làm nghề thiết kế API.