Thực hành 'tốt nhất' cho phản hồi POST yên tĩnh

Vì vậy, không có gì mới ở đây tôi chỉ đang cố gắng để làm rõ và dường như không thể tìm thấy bất kỳ trong các bài viết khác.

Tôi đang tạo ra một nguồn tài nguyên mới một cách đầy đủ, nói:

/books (POST)

với một cơ thể:

{
  title: 'The Lion, the Witch and the Wardrobe',
  author: 'C. S. Lewis'
}

Tôi biết rằng tôi nên trả lại một 201 (Đã tạo) với tiêu đề Vị trí của tài nguyên mới:

Location: /books/12345

Câu hỏi tôi dường như không thể tự trả lời là máy chủ nên trả về cái gì trong cơ thể.

Tôi thường thực hiện loại phản ứng này:

{
  id: 12345,
  title: 'The Lion, the Witch and the Wardrobe',
  author: 'C. S. Lewis'
}

Tôi đã làm điều này vì một vài lý do:

1. Tôi đã viết api cho các khung giao diện người dùng như angularjs. Trong trường hợp cụ thể của tôi, tôi đang sử dụng tài nguyên góc và tôi thường chỉ cần id cho tài nguyên để xác định vị trí của nó. Nếu tôi không trả lại id trong phần phản hồi, tôi sẽ cần phân tích nó ra khỏi tiêu đề Vị trí.
2. Trong một GET của tất cả các cuốn sách, tôi thường trả lại toàn bộ đối tượng không chỉ là id. Theo nghĩa này, mã máy khách của tôi không phải phân biệt nơi lấy id từ (tiêu đề vị trí hoặc phần thân).

Bây giờ tôi biết tôi thực sự ở trong khu vực màu xám ở đây, nhưng hầu hết mọi người đang nói rằng trả lại toàn bộ tài nguyên là thực tế 'xấu'. Nhưng nếu máy chủ thay đổi / thêm thông tin vào tài nguyên. Nó chắc chắn thêm id, nhưng cũng có thể thêm những thứ khác như dấu thời gian. Trong trường hợp tôi không trả lại toàn bộ tài nguyên, có thực sự tốt hơn khi thực hiện POST, trả lại id, sau đó để máy khách thực hiện GET để lấy tài nguyên mới.

Trả lại toàn bộ đối tượng trên một bản cập nhật có vẻ không liên quan lắm, nhưng tôi khó có thể hiểu tại sao việc trả lại toàn bộ đối tượng khi nó được tạo sẽ là một thực tiễn xấu trong trường hợp sử dụng thông thường. Điều này sẽ hữu ích ít nhất là để có được ID dễ dàng và để có được dấu thời gian khi có liên quan. Đây thực sự là hành vi mặc định có được khi giàn giáo với Rails.

Tôi thực sự không thấy bất kỳ lợi thế nào khi chỉ trả lại ID và thực hiện yêu cầu GET sau đó, để có được dữ liệu bạn có thể nhận được với POST ban đầu của mình.

Dù sao, miễn là API của bạn nhất quán, tôi nghĩ rằng bạn nên chọn mẫu phù hợp với nhu cầu của mình nhất. Không có bất kỳ cách chính xác nào về cách xây dựng API REST, imo.

Trả lại đối tượng mới phù hợp với nguyên tắc REST của "Giao diện thống nhất - Thao tác tài nguyên thông qua các biểu diễn." Đối tượng hoàn chỉnh là đại diện cho trạng thái mới của đối tượng đã được tạo.

Có một tài liệu tham khảo thực sự tuyệt vời cho thiết kế API, ở đây: Thực tiễn tốt nhất để thiết kế API RESTful thực dụng

Nó bao gồm một câu trả lời cho câu hỏi của bạn ở đây: Cập nhật & tạo sẽ trả lại một đại diện tài nguyên

Nó nói rằng:

Để ngăn người tiêu dùng API không phải đánh lại API cho đại diện được cập nhật, hãy yêu cầu API trả lại đại diện đã cập nhật (hoặc được tạo) như một phần của phản hồi.

Có vẻ thực dụng với tôi và nó phù hợp với nguyên tắc REST mà tôi đã đề cập ở trên.