Есть ли предпочтительный способ перечисления ошибок в ответ на запрос API? - PullRequest
2 голосов
/ 28 июня 2011

Я создаю JSON REST API. Некоторые действия API требуют атрибутов. Если запрос API к этим действиям выполняется без всех необходимых атрибутов, API возвращает HTTP-код 4xx и список отсутствующих атрибутов в формате JSON.

Пока что этот JSON-ответ содержит только объект с ключом «errors», хранящий массив сообщений об ошибках. Например:

{"errors":["'first_name' attribute is missing","'title' attribute is missing"]}

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

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

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...