如何返回不含<string>元素的XML？XML序列化节点格式与响应包裹问题解决

我来帮你搞定这两个困扰你的XML序列化问题，咱们一步步来拆解：

第一个问题：去掉响应里的<string>包裹元素 #

你看到的这个<string>节点，是因为你的API方法返回的是string类型，ASP.NET Web API默认会用DataContractSerializer对字符串做序列化，自动加上了这个包裹。要去掉它，有两种简单的办法：

方法一：直接返回模型对象，让Web API帮你序列化 #

把API方法的返回类型改成SwRequestListModel，同时配置Web API使用你定义的XmlSerializer规则，而不是默认的序列化器：

1. 修改API方法：

[HttpGet]
public SwRequestListModel GetRequestList(string date, string status, string systemType) {
    SwRequestListModel result = new SwRequestListModel();
    result.ApiVersion = "1.0";
    // 这里填充你的数据逻辑
    return result;
}

2. 在WebApiConfig.cs里添加配置，让Web API使用XmlSerializer：

config.Formatters.XmlFormatter.UseXmlSerializer = true;

这样Web API会自动按照你给模型加的[XmlElement]等属性生成正确的XML，再也不会出现<string>包裹了。

方法二：返回HttpResponseMessage（如果你想自己控制序列化） #

如果你还是想保留手动序列化的逻辑，可以返回HttpResponseMessage，直接把你生成的XML作为响应内容输出：

[HttpGet]
public HttpResponseMessage GetRequestList(string date, string status, string systemType) {
    SwRequestListModel result = new SwRequestListModel();
    result.ApiVersion = "1.0";
    // 填充数据
    string xml = result.ToXml();
    var response = new HttpResponseMessage(HttpStatusCode.OK);
    response.Content = new StringContent(xml, Encoding.UTF8, "application/xml");
    return response;
}

这种方式会直接把你生成的XML返回给前端，不会加任何额外的包裹节点。

第二个问题：调整节点格式 #

从你的代码和当前输出看，现在SwRequest列表会被序列化成多个直接挂在<result>下的<sw_request>节点。如果你希望这些列表项被一个父节点（比如<sw_requests>）包裹，只需要修改模型的序列化属性：

更新SwRequestListModel里的SwRequest属性：

[XmlRoot("result")]
public class SwRequestListModel {
    public SwRequestListModel() {
        SwRequest = new List<SwRequestShortInfo>();
    }
    [XmlElement("api_version")]
    public string ApiVersion { get; set; }
    // 把原来的[XmlElement]换成下面两个属性
    [XmlArray("sw_requests")] // 定义列表的父节点名称
    [XmlArrayItem("sw_request")] // 定义每个列表项的节点名称
    public List<SwRequestShortInfo> SwRequest { get; set; }
}

修改后，序列化出来的XML会变成这样：

<result>
  <api_version>1.0</api_version>
  <sw_requests>
    <sw_request>
      <sw_ref_number>588</sw_ref_number>
      <!-- 其他属性节点 -->
    </sw_request>
    <!-- 更多sw_request项 -->
  </sw_requests>
</result>

另外，注意你的SwRequestShortInfo类上的[XmlRoot]属性其实没用——这个属性只在对象作为XML根节点时生效，作为列表项时不会起作用，你可以把它删掉，或者如果希望每个列表项的节点名称是<sw_request_short_info>，那把XmlArrayItem的参数改成这个名称就行。

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