Правильна відповідь REST для порожнього столу?

Скажімо, ви хочете отримати список користувачів, зателефонувавши GETдо них api/users, але наразі таблиця була врізана, тому користувачів немає. Яка відповідна відповідь для цього сценарію: 404чи 204?

Я б сказав, жодне.

Чому б не 404 (не знайдено)?

Код стану 404 повинен бути зарезервований для ситуацій, коли ресурс не знайдений. У цьому випадку ваш ресурс - це сукупність користувачів . Ця колекція існує, але наразі вона порожня. Особисто я був би дуже заплутаний як автор клієнта вашої заявки, якщо я отримав 200один і 404наступний день лише тому, що хтось видав пару користувачів. Що я повинен робити? Моя URL-адреса неправильна? Хтось змінив API та знехтував залишити переадресацію.

Чому б не 204 (Без вмісту)?

Ось уривок з опису коду статусу 204 від w3c

Сервер виконав цей запит, але йому не потрібно повертати тіло об'єкта і, можливо, захоче повернути оновлену інформацію.

Хоча це може здатися розумним у цьому випадку, я думаю, що це також збентежить клієнтів. A 204повинен означати, що деяка операція виконана успішно, і дані не потрібно повертати. Це ідеально, як відповідь на DELETEзапит або, можливо, запуск якогось сценарію, для якого не потрібно повертати дані. У випадку api/users, як правило, ви розраховуєте отримати представництво своєї колекції користувачів. Надіслати орган відповіді один раз, а інший раз не надіслати його, є непослідовним та потенційно оманливим.

Чому я використовую 200 (ОК)

З причин, зазначених вище (послідовність), я б повернув представлення порожньої колекції. Припустимо, ви використовуєте XML. Нормальний орган реагування на непусту колекцію користувачів може виглядати так:

<users>
  <user>
    <id>1</id>
    <name>Tom</name>
  </user>
  <user>
    <id>2</id>
    <name>IMB</name>
  </user>
</users>

і якщо список порожній, ви можете просто відповісти чимось подібним (поки все ще використовуєте a 200):

<users/>

Так чи інакше, клієнт отримує орган відповіді, який дотримується певного, добре відомого формату. Немає зайвої плутанини та перевірки коду статусу. Також не порушується визначення коду статусу. Усі щасливі.

Ви можете зробити те ж саме з JSON або HTML або будь-яким іншим форматом.

Я відповів би на один з двох кодів залежно від ситуації виконання:

404 Не знайдено)

Ця відповідь досить правильна, якщо у вас немає таблиці. Не просто порожній стіл, але НЕ ТАКОЖИ КОРИСТУВАЧА. Це підтверджує точну думку - ресурсу немає. Подальші варіанти - надати детальнішу інформацію. ЧОМУ ваша таблиця відсутня, є кілька більш детальних кодів, але 404 досить добре посилатися на ситуацію, коли у вас справді немає таблиці.

200 (ОК)

Усі випадки, коли у вас таблиця, але вона порожня або ваш запитуючий процесор відфільтрував усі результати. Це означає, що "ваш запит правильний, все в порядку, але ви не відповідаєте жодним даним, тому що або ми не маємо даних, або ми не маємо даних, які відповідають вашому запиту. Це має відрізнятися від відповіді на заборону безпеки. Я також голосую за повернення 200 у випадку, коли у вас є деякі дані, і взагалі ви маєте доступ до таблиці, але у вас немає доступу до всіх даних, які відповідають вашому запиту (дані були відфільтровані через захист рівня об'єкта, але взагалі вам дозволяється запит).

Якщо ви очікуєте переліку об’єктів користувача, найкращим рішенням буде повернення порожнього списку ([]) з 200 ОК, ніж використання відповіді 404 або 204.

однозначно повертає 200.

404 означає, що ресурс не знайдено. Але ресурс існує. А також, якщо відповідь має статус 404. Як ви можете знати, що список користувачів порожній або заповнений?

• '/ users', якщо порожній, повинен повернути "200".
• '/ users / 1', якщо ідентифікатор не знайдено. має повернути 404.

Потрібно 200 ОК з порожнім списком.

Чому: порожня таблиця означає, що таблиця існує, але не має жодної записи.

404 Не знайдено, запитувана кінцева точка не існує.