Необработанные и поисковые значения в REST API

#rest #api

#отдых #API

Вопрос:

Мы внедряем REST API в наш проект и не можем достичь консенсуса относительно данных ответа.

Итак, у нас есть несколько объектов «code». Эти объекты содержат код полей (простой буквенно-цифровой идентификатор) и описание этого кода (некоторый описывающий текст). На некоторых страницах текущего клиентского приложения нам необходимо отображать значения поиска на основе пользовательских настроек (например, Code — Description или Description — Code). Должен ли REST API возвращать настроенные значения или он должен возвращать только необработанные значения кода? Я считаю, что представление является обязанностью клиента.

Что вы думаете?

Комментарии:

1. Настраиваются ли описания? Если это так, вам также нужно будет вернуть описание, поскольку клиент не может знать его значение априори . Если нет, то лично я бы также вернул описание, поскольку это позволит вам централизованно управлять им в будущем — это более удобно в обслуживании.

Ответ №1:

Я бы вернул как код, так и описание. Если клиент не хочет использовать описание, предоставленное сервером, он может просто проигнорировать его.


Если вам нужна интернационализация, поддержите Accept-Language HTTP-заголовок, чтобы предоставить описание в соответствии с желаемым языком.