Đối số cho danh từ số ít trong đặt tên tài nguyên API RESTful là gì?


12

Tôi hiểu rằng khi đặt tên RESTRI URI, người ta thường chấp nhận sử dụng số nhiều để thể hiện các bộ sưu tập tài nguyên. Tôi tò mò về lập luận cho việc sử dụng danh từ số ít thay thế.


có lẽ bởi vì không phải tất cả mọi thứ là một bộ sưu tập?
jwenting

Không phải đó là nơi mà một nguồn tài nguyên đơn lẻ sẽ phát huy tác dụng sao?
thiện

Câu trả lời:


12

Một số tài nguyên chỉ chứa một mục duy nhất. Các ví dụ tốt sẽ là mọi thứ mà bạn không cần ID để tìm ra dữ liệu nào sẽ hiển thị. Ví dụ rất phổ biến sẽ là tài nguyên Đăng nhập. Bạn chỉ có (từ chế độ xem người dùng và trình duyệt) chỉ một lần đăng nhập. Bạn có thể tạo nó, bạn có thể phá hủy nó nhưng bạn sẽ không có hành động lập chỉ mục với một số Đăng nhập để lựa chọn.

Các ví dụ tương tự sẽ là một số trang chủ yếu là tĩnh như thông tin công ty, dấu ấn, biểu mẫu liên hệ và những thứ tương tự chỉ hiển thị một mục duy nhất hoặc chỉ cho phép một hành động tạo duy nhất.

Nó có thể là một vấn đề thảo luận nếu sử dụng danh từ số ít thực sự bổ sung nhiều vào khả năng đọc mã.


5

Bởi vì:

  1. Các quy tắc số nhiều tiếng Anh như "anh đào" không phải là điều tốt nhất để nghĩ đến khi phát triển API, đặc biệt khi tiếng Anh không phải là tiếng mẹ đẻ của bạn.
  2. Đôi khi bạn muốn tạo điểm cuối từ mô hình, thường là số ít. Nó không chơi độc đáo với ở trên.
  3. Đối số "thông thường bạn bắt đầu truy vấn bằng cách Nhận để hiển thị danh sách" không đề cập đến bất kỳ trường hợp sử dụng thực tế nào. Và cuối cùng bạn sẽ truy vấn các mục đơn lẻ nhiều hơn và thậm chí nhiều hơn một danh sách các mục.
Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.