400 BAD запит коду помилки HTTP, що означає?

У мене є запит JSON, який я публікую на HTTP-адресу.

Чи слід це трактувати як те, 400де requestedResourceіснує поле, але "Roman"це недійсне значення для цього поля?

[{requestedResource:"Roman"}] 

Чи слід це трактувати як те, 400де "blah"поле взагалі не існує?

[{blah:"Roman"}]

400 означає, що запит був неправильним. Іншими словами, потік даних, який клієнт відправляє на сервер, не відповідав правилам.

Що стосується API REST з корисним навантаженням JSON, 400-ти зазвичай, і я б правильно сказала, використовуються для вказівки на те, що JSON якимось чином недійсний відповідно до специфікації API для послуги.

За цією логікою обидва запропоновані вами сценарії повинні становити 400.

Уявіть, натомість це були XML, а не JSON. В обох випадках XML ніколи не пройде перевірку схеми - або через невизначений елемент, або через неправильне значення елемента. Це було б поганим проханням. Тут же угода.

Від w3.org

10.4.1 400 Поганий запит

Сервер не міг зрозуміти запит через неправильний синтаксис. Клієнт НЕ повинен повторювати запит без змін.

Вибір коду відповіді HTTP є досить легким завданням і може бути описаний простими правилами. Єдина хитра частина, яку часто забувають, - параграф 6.5 від RFC 7231:

За винятком випадків, коли відповідаючи на запит HEAD, сервер ДОЛЖНІ надіслати представлення, що містить пояснення ситуації з помилками, і чи є це тимчасовою чи постійною умовою.

Правила такі:

1. Якщо запит був успішним, поверніть 2xx код (3xx для переадресації). Якщо на сервері сталася внутрішня логічна помилка, поверніть 5xx. Якщо в запиті клієнта щось не так, поверніть 4xx-код.
2. Перегляньте наявний код відповіді із вибраної категорії. Якщо одна з них має ім’я, яке добре відповідає вашій ситуації, ви можете використовувати її. В іншому випадку просто резервний код до коду x00 (200, 400, 500). Якщо ви сумніваєтесь, повернення до коду x00.
3. Опис помилки повернення в тілі відповіді. Для 4xx-кодів він повинен містити достатньо інформації для розробника клієнта, щоб зрозуміти причину та виправити клієнта. Для 5xx з міркувань безпеки жодних деталей не слід розкривати.
4. Якщо клієнту потрібно розрізняти різні помилки та мати різну реакцію залежно від нього, визначте машиночитаний та розширюваний формат помилок та використовуйте його скрізь у вашому API. Це добре робити з самого початку.
5. Майте на увазі, що розробник клієнта може робити дивні речі і намагатися розбирати рядки, які ви повертаєте як людський читаний опис. І змінивши рядки, ви зламаєте таких погано написаних клієнтів. Тому завжди надайте машиночитаний опис і намагайтеся уникати повідомлень про додаткову інформацію в тексті.

Тож у вашому випадку я повернув 400 помилок і щось подібне, якщо "Roman" отриманий з введення користувача, і клієнт повинен мати конкретну реакцію:

{
    "error_type" : "unsupported_resource",
    "error_description" : "\"Roman\" is not supported"
}

або більш загальну помилку, якщо така ситуація є помилковою логічною помилкою у клієнта і не очікується, якщо розробник не зробив щось не так:

{
    "error_type" : "malformed_json",
    "error_description" : "\"Roman\" is not supported for \"requestedResource\" field"
}

В жодному випадку "синтаксис неправильно формується". Саме семантика помилкова. Отже, IMHO 400 є недоцільним. Замість цього було б доречно повернути 200 разом з якимось об'єктом помилок, таким як { "error": { "message": "Unknown request keyword" } }чи будь-який інший.

Розглянемо шляхи обробки клієнта. Помилка в синтаксисі (наприклад, недійсний JSON) - це помилка в логіці програми, іншими словами помилка якоїсь форми, і з нею слід поводитися відповідно, схожим на 403, скажімо; іншими словами, щось погане пішло не так.

Помилка у значенні параметра, з іншого боку, є помилкою семантики, можливо, через неправильно підтверджений ввід користувача. Це не помилка HTTP (хоча, мабуть, це може бути 422). Шлях обробки був би іншим.

Наприклад, у jQuery я вважаю за краще не писати жодного обробника помилок, який стосується як речей, таких як 500, так і певних семантичних помилок, що стосуються додатків. Інші рамки, Ember for one, також трактують помилки HTTP, такі як 400s і 500s, однаково як великі збої в жирі, вимагаючи від програміста виявити, що відбувається і розгалужувати залежно від того, чи є "справжньою" помилкою чи ні.

Використання 400кодів статусу для будь-якої іншої мети, ніж вказівка ​​на те, що запит є неправильним, просто помилково.

Якщо корисне навантаження запиту містить послідовність байтів, яку неможливо було проаналізувати як application/json(якщо сервер очікує, що цей формат даних), відповідний код статусу 415:

Сервер відмовляється обслуговувати запит, оскільки суть запиту знаходиться у форматі, не підтримуваному запитуваним ресурсом для запитуваного методу.

Якщо корисне навантаження запиту синтаксично правильне, але семантично неправильне, 422може бути використаний нестандартний код відповіді або стандартний 403код стану:

Сервер зрозумів запит, але відмовляється його виконувати. Авторизація не допоможе, і запит НЕ повинен повторюватися.

Подумайте про очікування.

Як клієнтський додаток, ви очікуєте знати, чи щось піде не так на стороні сервера. Якщо серверу потрібно видалити помилку, коли blahвона відсутня або requestedResourceзначення невірне, помилка 400 буде доречною.

Як доповнення, для тих, хто може зіткнутися з тією ж проблемою, що і моя, я використовую $.ajaxдля розміщення даних форми на сервері, і я також 400спочатку отримав помилку.

Припустимо, у мене змінна javascript,

var formData = {
    "name":"Gearon",
    "hobby":"Be different"
    }; 

Не використовуйте змінну formDataбезпосередньо як значення ключа, dataяк показано нижче:

$.ajax({
    type: "post",
    dataType: "json",
    url: "http://localhost/user/add",
    contentType: "application/json",
    data: formData,
    success: function(data, textStatus){
        alert("Data: " + data + "\nStatus: " + status); 
    }
});

Замість цього використовуйте JSON.stringify, щоб капсулювати наступне formData:

$.ajax({
    type: "post",
    dataType: "json",
    url: "http://localhost/user/add",
    contentType: "application/json",
    data: JSON.stringify(formData),
    success: function(data, textStatus){
        alert("Data: " + data + "\nStatus: " + status); 
    }
});

У будь-якому випадку, як показали інші, помилка полягає в тому, що сервер не міг розпізнати запит, викликаючи неправильний синтаксис, я просто піднімаю екземпляр на практиці. Сподіваюся, комусь це буде корисно.

Спочатку перевірте URL-адресу, що вона може бути неправильною, якщо вона правильна, то перевірте те, що ви надсилаєте, орган запиту, який ви надсилаєте, можлива причина - запит про те, що ви надсилаєте, відсутній правильний синтаксис.

Щоб уточнити, перевірте наявність спеціальних символів у рядку запиту. Якщо він використовується (спеціальний знак), це першопричина цієї помилки.

спробуйте скопіювати запит і проаналізувати дані кожного тегу.