Лучшие практики для кодов состояния ответа API

Question

Я строй API и я возвращаю этот вид кодов состояния для каждого метода (например, «register_user»):

• 200 (OK), когда пользователь был запомненные
• 403 (запрещено), когда есть недостающие параметры в запросе
• 409 (конфликт), когда пользователь уже зарегистрирован

В дополнение к коду состояния я возвращаю поле «сообщение», объясняющее, что произошло. Считаете ли вы, что возвращение этих кодов в этом примере является хорошей практикой? Или я должен вернуть 200 во всех из них, кроме ошибки в поле «сообщение»?

Answer 1

Код статуса 403 (Запрещенный) указывает, что сервер понял запрос, но отказывается его авторизовать. Сервер, который желает, чтобы публиковал, почему запрос был запрещен, может описать причину в полезной нагрузке ответа (если таковая имеется) .

- RFC 7231, 6.5.3

Это не походит на то, что у вас есть на всех. Два других разумны. Отсутствующие параметры обычно обрабатываются с помощью кода ответа 400.