RESTful Web服务：尝试使用自定义XML实现HATEOAS

Question

我正在开发一个企业系统，它将在移动客户端和中央服务器之间使用RESTful Web服务。 尽可能使用RESTful，让我们说。

我的问题涉及HATEOAS（超媒体作为应用程序状态的引擎），以及在HTTP响应主体中使用自定义xml。

该系统永远不会被公共客户端使用，但我喜欢HATEOAS的想法，即能够在以后修改服务器端资源分配模式，而无需独立地重新配置每个客户端。 如果我们决定由于扩展问题我们需要在多个物理盒上扩展服务器功能，没问题，这将反映在客户端（或来自客户端的指令下的服务器）创建新资源时生成的URI中。

我们的业务领域非常具体和不寻常。 因此，我想在整个Web服务中为HTTP响应实体主体使用自定义XML，并且客户端将从xml中解析资源URI，以便随时了解它在修改自己的应用程序状态时可以使用的资源位置。 我知道这会“打破”HATEAOS的H部分。

例如，当客户端将事务发送到服务器进行处理时，服务器可能在201 HTTP响应主体中包含以下xml片段（作为更大的xml文档的一部分）。 服务器还会通知客户端新创建的事务资源本身的URI，但这可能只包含在Location HTTP头中。

<resulturi>http://resultserver/results/1234.xml</resulturi>

这真糟糕吗？ 使用此服务的客户端几乎不可能基于浏览器。 超媒体在xml中以纯文本形式提供uris的其他优点是什么？

我想我可以去XHTML，但我们的移动平台上的解析器使用POX更有效率。

Answer 1

你在resulturi中返回url所做的事实上已经是超媒体了。 唯一的问题是，您需要一种媒体类型，告诉客户端如何格式化响应，以便它可以以可预测和记录的方式解析URL。

选项1：创建自己的媒体类型，如vnd.yourcompany.Resource + xml。 通过执行此操作，您将声明媒体类型可以由xml解析器解析，但它遵循由您的公司定义的一些特殊规则。 此时，您可以使用任何标准来定义超媒体链接（请参阅此问题）。 这样做的一个很好的优点是，如果在6个月内您决定需要对XML的格式进行重大更改，您可以创建一个vnd.yourcompany.ResourceV2 + xml，只要您足够聪明以使用接受 - 在您的旧客户端上，您可以通过使新的客户端应用程序接受新格式，顺利地将新格式与旧格式并行引入。

选项2：我对这个选项只有一半认真，但我考虑过推动一种名为application / hyperxml + xml的新的mediatype。 该文档将遵循与application / xml相同的规则，但也会使用XLink进行超媒体。 这将允许使用javascript解析XML文档的人也以标准化方式利用超媒体。

选项3：使用XHtml。 我不明白为什么你的解析器有Xhtml的问题，但我会接受你的话。

Answer 2

无论底层标记语言如何，RESTful服务器处理请求都需要两条重要的信息：媒体类型和URI。 假设给定URI的媒体类型将引入客户端 - 服务器耦合。 例如，它会阻止相同的URI提供两种不同类型的媒体类型。

在设计超媒体格式时，XML不是唯一的选择。 查看Sun Cloud API ，它定义了基于JSON的超文本驱动的 REST API（尽管它似乎没有使用带有超链接的媒体类型）。 从这种方法转变为将媒体类型与超链接相结合的方法并不困难。

例如，您可以定义一个名为Link的JSON数据结构，如下所示;

{
  "name":"human-readable label for link",
  "uri":"http://example.com/resources/123",
  "media_type":"application/vnd.com.example.Resource+json"
}

Answer 3

Hypermedia不需要HTML甚至完全限定的URI。 如果您的媒体类型定义了将响应的某些元素转换为可引用资源的规则，那么您就拥有了超媒体。

<result>1234</result>

以上示例结合关于如何取消引用结果元素内容的媒体类型规则是超媒体，其方式与：

<result>/foo/1234</result>

有一个规则来预先添加基本http URI。 下面是一个示例，其中http字符串是可解除引用的事实可能是隐含的。

<result>http://myserver.com/foo/1234</result>

然而，虽然它们都是超媒体并且满足了这种约束，但我会反对创建自己的新超媒体制作规则和标签，如果可能的话，只需重新使用现有规则和标签。 第一个示例使用户不太明白此元素表示超过上一个示例的超链接资源。

Answer 4

我建议不要手动编码这些超链接，而是使用为您创建这些超链接的工具。 面向交互的编程是创建这些交互（超链接）的好方法。 请关注此链接，此技术适用于我们http://www.masterkube.com/hateoas_technology.html

Answer 5

至少（即使你什么也不做），你应该把你的URL放在XLink属性而不是元素内容中：

<resulturi xlink:href="http://resultserver/results/1234.xml"/>

XML处理器能够本地解析和跟踪这些URI作为URI。 作为一般规则，不可翻译或永远不能具有子元素的文本应该属于强制执行此类限制的属性。

但除此之外，做其他人的建议并定义您的媒体类型，以便客户可以理解其含义。