如何在Web API中同时返回数据总数与数据并输出XML格式？

我原本想统计Web API中的记录数，现在补充需求：需要在Web API中同时返回数据总数和对应的数据列表。之前尝试用if语句只返回了总数，而且数据没法按预期的XML格式展示。我想要实现类似下面JSON结构的XML输出：

{
  "Count": 2, 
  "Data": [
    {
     "userid": 1,
     "name": "emily",
     "mobile": "98724954",
     "Age": 24,
     "Date": "2020-10-04T21:05:00"
     },
     {
     "userid": 2,
     "name": "peter",
     "mobile": "42896592",
     "Age": 35,
     "Date": "2021-05-25T11:20:00"
     }
    ]
}

我之前的代码是这样的：

if(test.Count>0)
{
   return Ok(test.Count());
}
else
{
   return Ok("None");
};

返回的结果只有总数的XML：

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">10</int>

我的实体类定义如下：

public class TestClass
{
    public string UserId { get; set; }
    public string Name { get; set; }
    public string Mobile { get; set; }
    public int Access { get; set; }
    public DateTime Date { get; set; }
}

现在想知道怎么实现同时返回总数和数据列表的XML格式输出。

要实现同时返回总数和数据列表的XML（或JSON）输出，核心是创建一个包装类来统一承载这两个数据，让序列化器能正确生成嵌套结构。

步骤1：创建包装类 #

定义一个包含Count和Data属性的类，Data的类型为List<TestClass>：

public class TestResponse
{
    public int Count { get; set; }
    public List<TestClass> Data { get; set; }
}

步骤2：修改API接口代码 #

不再单独返回总数或字符串，而是返回包装类的实例：

// 假设test是你的TestClass集合
var response = new TestResponse
{
    Count = test.Count(),
    Data = test.ToList()
};

// 无数据时Count设为0，Data返回空列表即可，无需单独返回"None"
return Ok(response);

步骤3：验证XML输出 #

修改后，当请求指定XML格式（通过请求头Accept: application/xml）时，会得到类似以下的XML结构：

<TestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YourNamespace">
    <Count>2</Count>
    <Data>
        <TestClass>
            <Access>24</Access>
            <Date>2020-10-04T21:05:00</Date>
            <Mobile>98724954</Mobile>
            <Name>emily</Name>
            <UserId>1</UserId>
        </TestClass>
        <TestClass>
            <Access>35</Access>
            <Date>2021-05-25T11:20:00</Date>
            <Mobile>42896592</Mobile>
            <Name>peter</Name>
            <UserId>2</UserId>
        </TestClass>
    </Data>
</TestResponse>

注意事项 #

• 若使用ASP.NET Core，需在Program.cs中配置XML序列化支持：builder.Services.AddControllers().AddXmlSerializerFormatters();
• 统一返回包装类结构，前端处理逻辑更简洁，无需额外判断不同的返回类型

内容的提问来源于stack exchange，提问作者user19613128