WebAPI Controller返回XML格式异常 无缩进无法被调用方识别

核心问题根由 #

1. XML无缩进：你手动拼接的XML字符串本身是无格式的单行内容，XmlDocument.LoadXml加载后生成的XmlElement不携带格式化信息，WebAPI默认XML序列化也未开启缩进配置，所以返回的原始内容就是单行的。浏览器展示时会自动格式化XML方便阅读，但源码和原始响应内容本身还是单行状态，这种单行XML本身是合法的，不影响机器解析，仅影响人类阅读体验。
2. Content-Type自动识别失效：WebAPI默认使用内容协商机制匹配返回格式，客户端发送Accept: */*时如果JSON格式化器优先级更高，会默认返回JSON格式头，导致客户端无法自动识别XML内容。你返回XmlElement时部分版本WebAPI不会主动设置正确的XML Content-Type，所以需要手动配置。
3. 额外优化点：ReturnRegistered方法中对同一个接口发起了两次完全相同的HTTP请求，属于多余的性能损耗，可以优化为单次请求重复读取响应流。

解决方案 #

1. 优化重复API请求 #

修改ReturnRegistered方法，用MemoryStream缓存响应流实现单次请求多次读取：

public string ReturnRegistered(String personalID)
{
    string apiurl = apiadress + personalID;
    WebRequest request = WebRequest.Create(apiurl);
    request.PreAuthenticate = true;
    request.Credentials = new NetworkCredential(user, pass);

    using WebResponse respons = request.GetResponse();
    using Stream dataStream = respons.GetResponseStream();
    // 缓存流到内存
    using MemoryStream ms = new MemoryStream();
    dataStream.CopyTo(ms);
    ms.Seek(0, SeekOrigin.Begin);

    // 第一次读取：反序列化对象
    XmlSerializer serializer = new XmlSerializer(typeof(List<PrimaryContact>), new XmlRootAttribute("QueueSlot"));
    var input = (List<PrimaryContact>)serializer.Deserialize(ms);
    string firstname = input[0].firstname;
    string lastname = input[0].lastname;
    string postalAddress = input[0].postalAddress;
    string zipCode = input[0].zipCode;
    string address = input[0].address;   

    // 第二次读取：定位到流开头，用XmlDocument读取节点
    ms.Seek(0, SeekOrigin.Begin);
    XmlDocument doc = new XmlDocument();
    doc.Load(ms);
    XmlNodeList elemList2 = doc.GetElementsByTagName("lastPaymentDate");
    string lastPaymentDate = elemList2[0].InnerText;            

    // 用SecurityElement.Escape转义特殊字符，避免生成非法XML
    String returnvalue = $"<Fields><Field><Name>lastPaymentDate</Name><Value>{SecurityElement.Escape(lastPaymentDate)}</Value></Field><Field><Name>Firstname</Name><Value>{SecurityElement.Escape(firstname)}</Value></Field><Field><Name>Lastname</Name><Value>{SecurityElement.Escape(lastname)}</Value></Field><Field><Name>Adress</Name><Value>{SecurityElement.Escape(address)}</Value></Field><Field><Name>ZipCode</Name><Value>{SecurityElement.Escape(zipCode)}</Value></Field><Field><Name>PostalAdress</Name><Value>{SecurityElement.Escape(postalAddress)}</Value></Field></Fields>";
    return returnvalue;
}

更推荐的做法是定义强类型模型，直接返回对象由框架自动序列化，避免手动拼接XML的风险。

2. 配置XML序列化规则 #

如果你用的是.NET Framework WebAPI

修改App_Start/WebApiConfig.cs文件，添加XML序列化配置：

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // 其他原有配置

        // 启用XML序列化，开启缩进
        config.Formatters.XmlFormatter.UseXmlSerializer = true;
        config.Formatters.XmlFormatter.Indent = true;
        // 将XML格式化器设为最高优先级，默认返回XML
        config.Formatters.Insert(0, config.Formatters.XmlFormatter);
    }
}

如果你用的是.NET Core/.NET 5+

修改Program.cs文件，添加XML序列化配置：

var builder = WebApplication.CreateBuilder(args);

// 添加控制器服务，启用XML序列化，开启缩进
builder.Services.AddControllers()
    .AddXmlSerializerFormatters()
    .AddXmlOptions(options =>
    {
        options.WriterSettings.Indent = true;
    });

// 可选：强制默认返回XML格式，不根据Accept头协商
builder.Services.Configure<MvcOptions>(options =>
{
    options.OutputFormatters.Insert(0, new XmlSerializerOutputFormatter());
});

// 其他原有配置

var app = builder.Build();
// 其他中间件配置
app.Run();

3. 控制器显式指定返回Content-Type #

修改控制器代码，显式指定返回的Content-Type为text/xml，确保客户端能自动识别格式：

.NET Framework 版本

public IHttpActionResult Get(string id)
{
    Models.TomtkoRegistered tomtko = new Models.TomtkoRegistered();
    string returnvalue = tomtko.ReturnRegistered(id);     
    XmlDocument doc = new XmlDocument();
    doc.LoadXml(returnvalue);
    // 显式指定返回格式为XML，Content-Type为text/xml
    return Content(HttpStatusCode.OK, doc.DocumentElement, Configuration.Formatters.XmlFormatter, "text/xml");
}

.NET Core/.NET 5+ 版本

public IActionResult Get(string id)
{
    Models.TomtkoRegistered tomtko = new Models.TomtkoRegistered();
    string returnvalue = tomtko.ReturnRegistered(id);     
    // 直接返回XML字符串，显式设置Content-Type
    return Content(returnvalue, "text/xml");
}

额外说明 #

• 配置开启缩进后，返回的原始XML就会携带缩进和换行，源码查看时会有层级结构。
• 显式设置Content-Type: text/xml后，Postman、浏览器等客户端都会自动识别为XML格式，无需手动指定解析类型。
• 如果不需要人类阅读原始响应，不开缩进也不会影响XML的合法性和机器解析效果，还能减少响应体积提升传输效率。

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