Що є аргументом для іменників однини в іменуванні ресурсів RESTful API?


12

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


можливо тому, що не все - це колекція?
jwenting

Хіба це не те, де буде грати одиночний ресурс?
благодійність

Відповіді:


12

Деякі ресурси містять лише один елемент. Хорошими прикладами буде все, для чого вам не потрібен ідентифікатор, щоб з’ясувати, які дані потрібно відображати. Дуже поширеним, наприклад, буде ресурс Вхід. Ви маєте (з перегляду користувачів та браузерів) лише один логін. Ви можете створити його, ви можете знищити його, але у вас не буде індексу з кількома входами на вибір.

Подібними прикладами можуть бути деякі, в основному, статичні сторінки, такі як інформація про компанію, відбитки, форми контактів та подібні речі, які відображають лише один предмет або дозволяють лише одну дію створення.

Це може бути питанням обговорення, якщо використання іменників однини дійсно додасть багато для читабельності коду.


5

Тому що:

  1. Правила множини англійської мови, такі як "вишня", - це не найприємніше, що потрібно думати при розробці API, особливо коли англійська мова не є вашою рідною мовою.
  2. Іноді потрібно сформувати кінцеву точку з моделі, яка зазвичай є єдиною. З вищезгаданим це не гарно грає.
  3. Аргумент "зазвичай ви починаєте запитувати за допомогою" Get to display list ") не стосується жодного реального випадку використання. І в кінцевому підсумку ви будете запитувати по одних елементах стільки ж, скільки навіть у списку елементів.
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.