Как ответить на неверный параметр сортировки

Question

Представьте, что у меня есть конечная точка в REST API, которая поддерживает только такие параметры сортировки: дата и цена. Как я должен реагировать на вызов API, который запрашивает данные, отсортированные по налоговой ставке?

Для параметра фильтра это не сложно, я возвращаю пустой список. но я должен сделать то же самое для параметра сортировки или просто проигнорировать неверный параметр сортировки и вернуть данные, основанные на других параметрах?

Я знаю, что в некоторых случаях нет строгого ответа на вопросы разработки API, я Любопытно узнать, какой подход поддерживает более широкий спектр вариантов использования.

Answer 1

Полагаю, в обоих случаях либо неизвестный фильтр, либо неизвестный тип сортировки, API должен отвечать одинаково. Такой ответ обычно находится в Client Errors (400-499) категориях.

И причина в том, что API должны иметь строгую и определенную спецификацию. И такие спецификации явно упоминают допустимые типы фильтров и допустимые типы сортировки. Если любой запрос, который не удовлетворяет спецификации, должен быть приведен к 400 * диапазонам ошибок. Это то, что я считаю предпочтительным ответом, поэтому клиент, делающий запрос, также знает, что он нарушает спецификацию API.

По своему опыту я также видел много спецификаций, в которых упоминается игнорирование неизвестных параметров из запроса. И в этом случае вы получите ответ по умолчанию. Если ваш API документ, что в вашей спецификации ясно, то это правильный ответ.