Какой аргумент используется для имен существительных в именах ресурсов API RESTful?


12

Я понимаю, что при присвоении имен RESTful URI принято использовать множественное число для представления коллекций ресурсов. Мне любопытно аргумент в пользу использования существительных в единственном числе.


может потому что не все это коллекция?
Вечер

Разве это не то, где ресурс синглтона вступит в игру?
милосердие

Ответы:


12

Некоторые ресурсы содержат только один элемент. Хорошие примеры - это все, для чего вам не нужен идентификатор, чтобы узнать, какие данные отображать. Например, очень распространенным является ресурс Login. У вас есть (с точки зрения пользователей и браузеров) только один логин. Вы можете создать его, вы можете уничтожить его, но у вас не будет действия index с несколькими логинами на выбор.

Подобными примерами могут быть некоторые в основном статические страницы, такие как информация о компании, выходные данные, контактные формы и тому подобные вещи, которые отображают только один элемент или допускают только одно действие создания.

Это может быть предметом обсуждения, если использование исключительных существительных действительно сильно улучшает читабельность кода.


5

Так как:

  1. Правила множественного числа в английском, такие как «вишня», - не самая приятная вещь при разработке API, особенно когда английский не является вашим родным языком.
  2. Иногда вы хотите создать конечную точку из модели, которая обычно является единственной. Это не играет хорошо с вышеупомянутым.
  3. Аргумент «обычно вы начинаете запрашивать с помощью Get для отображения списка» не относится ни к какому реальному варианту использования. И вы закончите тем, что будете запрашивать отдельные элементы столько же, сколько даже список элементов.
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.