api - REST 风格的 API : How to handle translated textfields in representations?

Question

我正在为预订应用程序设计一个 RESTful API。您可以索取住宿 list 或详细信息。由于应用程序面向多语言受众，因此(有时)可以使用不同语言进行描述。

现在我不确定如何处理住宿表示中的这些翻译。如果没有多种语言，我会非常简单地“描述”一个字段或住宿对象。

知道如何优雅地解决这个问题吗？

我目前的想法:添加一个包含文本<->文化对的描述列表，而不是描述字段和一个额外的子资源 /descriptions 到创建 (POST)、更新 (PUT) ) 和删除 (DELETE) 新翻译。

Answer 1

要以适当的语言检索表示，您只需设置 Accept-Language HTTP header 。

请求:

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>