Luôn trả về các đối tượng đơn lẻ trong một mảng cho các tải trọng JSON API REST?

Đối với API REST mà tôi đang làm việc, tôi muốn trả về JSON theo bố cục nhất quán:

{
  "Data" : {
     "Id" : 123,
     "Email" : "charlie@somewhere.com"
     "Firstname" : "Charlie",
     "Surname" : "Brown",
 },
 "Error" : null
}

Tải trọng sẽ luôn chứa "Dữ liệu" và "Lỗi", trong đó một hoặc khác có thể là null.

Câu hỏi của tôi liên quan đến "Dữ liệu" và các điểm cuối chỉ thực sự trả về một đối tượng. Ví dụ: giả sử tôi có API users/current, trả về người dùng hiện được xác thực. Tôi đã trả lại người dùng đó như được hiển thị ở trên; một đối tượng JSON có tên là "Dữ liệu".

Đối với các điểm cuối có thể trả về 0, một hoặc nhiều đối tượng, thì tất nhiên tôi sẽ biến "Dữ liệu" thành một mảng:

{
  "Data" : [
    {
      (first object)
    },
    {
      (second object)
    }
  ],
  "Error" : null
}

Tôi đã nghe một quan điểm rằng, để thống nhất, "Dữ liệu" phải luôn là một mảng. Ngay cả khi một điểm cuối sẽ chỉ trả về một đối tượng duy nhất (hoặc null).

Người khác nghĩ gì? Tôi nghĩ rằng không cần phải tạo "Dữ liệu" và mảng nếu không bao giờ có nhiều hơn một đối tượng được trả về.

Tôi nghĩ rằng loại nhất quán này là sai lầm.

Việc gói dữ liệu trong một mảng không có khả năng mang lại lợi ích cho người tiêu dùng API, bởi vì anh ta vẫn sẽ phải biết cách diễn giải dữ liệu thực tế. Ví dụ, không có khả năng các kết quả "dữ liệu" của /users/currentvà /cities/chicago/restaurantssẽ được xử lý bởi cùng một mã.

Đối với các lỗi, mặt khác, nó là khả năng là tất cả các lỗi được xử lý bởi cùng một mã xử lý lỗi, và sau đó là một lợi ích để sử dụng cấu trúc tương tự.

Hãy tự hỏi mình điều này: nếu đây là một lớp trong ngôn ngữ OOP yêu thích của bạn, bạn có làm cho tất cả các phương thức trả về cùng một kiểu cho sự thống nhất không?

Nếu bên nhận cần một người nhận chung cho các thông báo JSON của bạn, thì có thể hữu ích khi nút dữ liệu có cùng định dạng. Vì vậy, trong trường hợp này, thật hữu ích khi luôn có một mảng, vì vậy nó có thể được phân tích cú pháp theo cùng một cách mọi lúc.

Nếu mỗi phản hồi sẽ được xử lý riêng lẻ (các lệnh gọi API khác nhau từ các phương thức khác nhau), tôi có thể thấy quan điểm của bạn, tuy nhiên nó sẽ hoàn toàn rõ ràng (từ các lệnh gọi API) khi một mảng hoặc một đối tượng được trả về.

Tôi không phải là người hâm mộ cách tiếp cận mảng vì nó không mang lại sự nhất quán thực sự. Nó buộc người dùng dịch vụ phải tự hỏi về những điều như, điều gì xảy ra nếu có nhiều hơn một đối tượng trong mảng này hoặc thoát khỏi sự bao bọc mảng càng sớm càng tốt cho các mảng singleton. Bạn vẫn phải làm hai việc khác nhau.

Tuy nhiên, nếu bạn sử dụng mảng, hãy đảm bảo rằng Dữ liệu không bao giờ là null. Nếu không có dữ liệu thì mảng sẽ trống. Đó là lợi thế duy nhất tôi có thể thấy.

Tôi đang rơi về phía luôn luôn trả lại một mảng. Về phía khách hàng, tôi sử dụng đối tượng phản hồi "Người dùng" của mình cho dù nhận được tất cả người dùng hay chỉ một người dùng. Nếu bạn có một điểm cuối trả về mảng và một điểm khác trả về cùng một đối tượng, nhưng không bao giờ nhiều hơn một, vẫn sử dụng một mảng.

Có các đối số tương tự cho việc sử dụng cùng một logic ở phía máy chủ, chỉ cần sử dụng cùng một mã cho dù truy vấn của bạn trả về một mục hay nhiều mục.

Ngoại lệ duy nhất sẽ là khi trả về một đối tượng không bao giờ tồn tại dưới dạng một mảng, trong bất kỳ bối cảnh nào, sau đó không có nhu cầu.