如何通过ASP.NET API Controller返回XML文件内容？

问题根源 #

• 返回xmlDoc.InnerXml时，Web API默认格式化器会把字符串序列化为带<string>根节点的XML，导致客户端无法正常解析原始结构。
• 直接返回XmlDocument时，由于它不具备符合要求的Add方法，被判定为无效集合类型，触发序列化异常。

可行解决方案 #

方案1：用HttpResponseMessage直接返回原始XML内容 #

绕过Web API默认格式化逻辑，直接读取文件内容并设置正确的响应类型：

[Route("cgi-bin/CGILink")]
[HttpGet]
public HttpResponseMessage CGILink(string cmd, string user, string passwd)
{
    try
    {
        string file = Path.Combine(HttpContext.Current.Server.MapPath("~"), "App_Data", "credential.xml");
        var response = new HttpResponseMessage(HttpStatusCode.OK);
        var xmlContent = File.ReadAllText(file);
        response.Content = new StringContent(xmlContent, Encoding.UTF8, "application/xml");
        return response;
    }
    catch (Exception ex)
    {
        return Request.CreateErrorResponse(HttpStatusCode.BadRequest, $"CGILink Failed: {ex.Message}");
    }
}

方案2：返回XmlNode类型替代XmlDocument #

XmlDocument继承自XmlNode，Web API内置了对XmlNode的XML格式化支持，直接返回即可：

[Route("cgi-bin/CGILink")]
[HttpGet]
public IHttpActionResult CGILink(string cmd, string user, string passwd)
{
    try
    {
        string file = Path.Combine(HttpContext.Current.Server.MapPath("~"), "App_Data", "credential.xml");
        XmlDocument xmlDoc = new XmlDocument();
        xmlDoc.Load(file);
        return Ok(xmlDoc as XmlNode);
    }
    catch (Exception ex)
    {
        return BadRequest($"CGILink Failed: {ex.Message}");
    }
}

此方法会自动处理XML声明和命名空间，确保输出结构符合客户端解析要求。

方案3：指定StringContent的媒体类型 #

如果要返回字符串形式的XML，手动创建StringContent并设置application/xml类型，避免默认格式化器的额外包裹：

[Route("cgi-bin/CGILink")]
[HttpGet]
public HttpResponseMessage CGILink(string cmd, string user, string passwd)
{
    try
    {
        string file = Path.Combine(HttpContext.Current.Server.MapPath("~"), "App_Data", "credential.xml");
        XmlDocument xmlDoc = new XmlDocument();
        xmlDoc.Load(file);
        var response = Request.CreateResponse(HttpStatusCode.OK);
        response.Content = new StringContent(xmlDoc.InnerXml, Encoding.UTF8, "application/xml");
        return response;
    }
    catch (Exception ex)
    {
        return Request.CreateErrorResponse(HttpStatusCode.BadRequest, $"CGILink Failed: {ex.Message}");
    }
}

效果验证 #

使用任意方案后，客户端收到的响应将是原始XML结构，无额外节点包裹，可直接加载到XmlDocument中解析。

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