xml的REST表示

时间:2010-12-03 14:33:52

标签: xml json api rest wadl

我正在构建一个REST api,并讨论我应该使用什么格式的xml表示。 我知道它可以是内部定义的,但也有很多格式。 wadl看起来很有趣,但似乎有关于它的争论,它也是新的。

有哪些建议(最佳做法)?

1 个答案:

答案 0 :(得分:0)

只要它是有效的XML就是一个开始。我对简单REST / XML服务的一般策略如下:

对于解析,您几乎肯定需要一个始终存在的单个根节点,例如“response”,可以包含结果元素或错误元素。 E.g:

<response>
  <result>
    <answer>5</answer>
  </result>
</response>

您构建结果的方式取决于您。您可以决定是将elemenets中的数据保存为CDATA(文本注释,如上所示)还是作为必需属性,例如:

<answer value="5"/>

有时有用的另一件事是在响应中包含原始查询,例如:

<response query="operation=add&a=2&b=3"> .. </response>

这样,如果您有多个未完成的查询,您可以将它们与原始请求匹配。