xml - XML API 中返回的错误格式

Question

我正在构建一个基于 XML 消息的 API。在它的一部分，接收几个实体并处理它们。

现在，如果其中一个实体出现处理错误，我想继续处理其他实体并为未处理的实体返回错误消息，以便消费者知道哪些实体未处理。

返回这些错误的最佳方法是什么，以便消费者确切地知道哪些实体失败了以及带有哪些错误消息？

这是请求的样子：

<entities>
  <entity>
    <title>first</title>
    <description>short text</description>
  </entity>
  <entity>
    <title>second</title>
    <description>second short text</description>
  </entity>
  <entity>
    <title>third</title>
    <description>third short text</description>
  </entity>
</entities>

现在让我们假设第一个和第三个实体产生错误。反应如何？

Answer 1

这是我选择的解决方案：

响应将类似于请求，这意味着它将包含相同的实体结构，但只会返回那些产生错误的实体，并且错误将被附加到原始实体节点。

<entities>
  <entity>
    <title>first</title>
    <description>short text</description>
  </entity>
  <errors>
    <error>first error</error>
    <error>second error</error>
  </errors>
</entities>