RESTful API: как обрабатывать переведенные текстовые поля в представлениях?

Question

Я разрабатываю RESTful API для приложения бронирования. Есть места, где вы можете запросить список или детали. Поскольку приложение предназначено для многоязычной аудитории, описания (иногда) доступны на разных языках.

Теперь я не уверен, как обращаться с этими переводами в представлении размещения. Без нескольких языков я сделал бы «описание» поля или объекта размещения довольно простым.

Есть идеи, как решить это элегантно?

Моя текущая идея: добавить список описаний с текстовыми парами <-> культур вместо поля описания и дополнительного подресурса /descriptions к размещению для создания (POST), обновления (PUT) и удаления (DELETE) новых переводов.

Answer 1

Для получения представлений на соответствующем языке вы просто устанавливаете HTTP-заголовок Accept-Language.

Запрос

GET /Hotel/345
Accept-Language: fr

Ответ

<Hotel>
  <Description xml:lang='fr'>Ce edifice est magnifique</Description>
</Hotel>

Для выполнения обновлений вы можете просто включить несколько элементов описания, при условии, что вы используете xml в качестве формата мультимедиа.

Запрос

PUT /Hotel/345

<Hotel>
  <Description xml:lang='en'>This building is magnificent</Description>
  <Description xml:lang='fr'>Ce edifice est magnifique</Description>
</Hotel>