Làm thế nào để cập nhật thứ tự của nhiều mục thông qua REST API?

Question

Tôi đang làm việc trên một API REST REST cho danh sách các mục menu điều hướng, khá nhiều cho mục đích học tập. Cho đến thời điểm này mọi thứ trong API khá đơn giản vì tôi chỉ phải sửa đổi các mục đơn lẻ thông qua công cụ cổ điển /collection/{id}.

Nhưng bây giờ Tôi muốn thay đổi thứ tự của danh sách các mục được lưu trữ trong các lĩnh vực order của cơ sở dữ liệu của tôi và dĩ nhiên Tôi không muốn làm một yêu cầu đối với từng mục trình đơn.

Vì vậy, cách nào là một cách thích hợp/phổ biến thực tiễn tốt nhất để làm điều này?

Tôi có thể tưởng tượng gửi yêu cầu PUT tới /collection với cặp khóa-giá trị id trong dữ liệu đã gửi nhưng Laravel (mà tôi sử dụng để tạo API) không cho phép điều này. Tôi chắc chắn có thể chơi xung quanh hạn chế đó nhưng tôi đoán có lý do hợp lý rằng điều này là không được phép.

Một ý tưởng khác là gửi yêu cầu PUT tới /collection/{ids} bằng danh sách ID được phân cách bằng dấu phẩy nhưng tôi cũng phải gửi danh sách khóa-giá trị ID và giá trị đơn đặt hàng của chúng có vẻ khá dư thừa và do với điều đó cũng hơi bẩn.

Vậy điều gì thực sự sẽ là phương pháp tốt nhất?

Answer 1

Tôi khuyên bạn nên xác định tuyến đường mới với đường dẫn tài nguyên:/collection/reorder.

Điều này cho phép gửi bằng cách sử dụng phương pháp POST danh sách các phần tử có vị trí mới của chúng. Nội dung sẽ có dạng như sau:

{ 
    "element1": 4, 
    "element2": 1, 
    (...) 
} 

"element1" là định danh của phần tử và giá trị tương ứng, thứ tự mới của phần tử đó.

Bạn có thể nhận thấy định dạng dữ liệu bạn cần gửi cho phương pháp này có thể phụ thuộc vào công cụ bạn sử dụng trong giao diện người dùng để sắp xếp lại danh sách (ví dụ, để kéo thả).

Hy vọng điều đó sẽ hữu ích. Thierry