如何构建REST API XML响应

时间:2011-03-02 18:24:59

标签: api http rest

我正在尝试定义如何从我的Web API返回XML内容。

Web服务器响应的根元素是否应始终称为“内容”,还是应该为每个API调用的响应定义(可能)不同的根元素?或者我甚至需要根密钥?

3 个答案:

答案 0 :(得分:1)

我会远离尝试自己定义它并使用像Atom或类似物一样的标准。正如我在另一个answer中提到的那样,对于这种类型的事物有precedent(无论你使用的是JSON还是XML)。

答案 1 :(得分:1)

这类问题表明JSON远远优于XML for data 的众多原因之一。您不必命名所有内容

建议:只使用JSON。

答案 2 :(得分:0)

我们维护的API具有单个常量根元素。真的,这取决于你。其他替代方案可能是每个数据返回类型的不同根,类的不同根,或者如您所说,每个函数的不同根。

我们的API结构类似于此(不是标准或任何标准):

<product name common root>
<class name>
<function return data>...</function return data>
</class name>
</product name common root>

我们还允许批量调用,因此这有助于确定哪些结果。

<product name common root>
<class name>
<function1 return data>...</function1 return data>
</class name>
<class2 name>
<function2 return data>...</function2 return data>
</class2 name>
</product name common root>