在ASP.NET Core的API开发中，默认情况下接口返回的是JSON格式的数据，但部分业务场景需要接口返回XML格式响应，比如对接旧系统、满足特定客户端的格式要求等。要实现XML格式的API响应，需要对项目的格式化器进行配置，同时了解请求和响应的相关处理规则。
添加XML格式化器
ASP.NET Core默认没有启用XML格式化功能，需要手动添加对应的NuGet包并配置服务。首先要在项目中安装Microsoft.AspNetCore.Mvc.Formatters.Xml包，安装完成后在Program.cs中配置MVC服务时添加XML格式化器。
以下是基础配置代码示例：
// Program.cs 中的服务配置部分
var builder = WebApplication.CreateBuilder(args);
// 添加控制器服务，并配置XML格式化器
builder.Services.AddControllers()
.AddXmlSerializerFormatters(); // 添加基于XmlSerializer的XML格式化器
var app = builder.Build();
// 启用路由和控制器
app.MapControllers();
app.Run();
这里添加的AddXmlSerializerFormatters方法会使用XmlSerializer来序列化对象为XML格式，如果需要使用DataContractSerializer，可以替换为AddXmlDataContractSerializerFormatters方法。
定义返回XML的API接口
配置完成XML格式化器后，接口可以直接返回对象，框架会根据请求的Accept头自动选择返回格式。如果需要强制返回XML格式，也可以通过指定Produces特性来实现。
自动根据请求头返回格式
当客户端请求的Accept头包含application/xml时，接口会自动返回XML格式数据，否则返回默认的JSON格式。以下是示例接口代码：
using Microsoft.AspNetCore.Mvc;
[ApiController]
[Route("api/[controller]")]
public class UserController : ControllerBase
{
[HttpGet("{id}")]
public IActionResult GetUser(int id)
{
var user = new User
{
Id = id,
Name = "张三",
Age = 25,
Email = "test@ipipp.com"
};
return Ok(user);
}
}
// 定义用户实体类
public class User
{
public int Id { get; set; }
public string Name { get; set; }
public int Age { get; set; }
public string Email { get; set; }
}
当使用PostMan等工具请求api/user/1，并在请求头中设置Accept: application/xml时，返回的内容如下：
<?xml version="1.0" encoding="utf-8"?> <User xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Id>1</Id> <Name>张三</Name> <Age>25</Age> <Email>test@ipipp.com</Email> </User>
强制返回XML格式
如果希望某个接口无论请求头如何都返回XML格式，可以在接口方法或者控制器上添加[Produces("application/xml")]特性：
[ApiController]
[Route("api/[controller]")]
[Produces("application/xml")] // 整个控制器下的接口都默认返回XML
public class ProductController : ControllerBase
{
[HttpGet]
public IActionResult GetProducts()
{
var products = new List<Product>
{
new Product { Id = 1, Name = "产品A", Price = 100 },
new Product { Id = 2, Name = "产品B", Price = 200 }
};
return Ok(products);
}
}
public class Product
{
public int Id { get; set; }
public string Name { get; set; }
public decimal Price { get; set; }
}
处理XML序列化的自定义需求
默认的XML序列化可能无法满足所有需求，比如需要自定义节点名称、忽略某些属性、设置命名空间等，可以通过在实体类上添加XML相关的特性来实现。
以下是自定义XML序列化的实体类示例：
using System.Xml.Serialization;
[XmlRoot("UserInfo")] // 自定义根节点名称
public class CustomUser
{
[XmlAttribute("UserId")] // 将Id作为根节点的属性
public int Id { get; set; }
[XmlElement("UserName")] // 自定义属性对应的节点名称
public string Name { get; set; }
[XmlIgnore] // 忽略该属性，不序列化到XML中
public int Age { get; set; }
public string Email { get; set; }
}
使用该实体类返回XML时，序列化结果会按照特性配置生成，比如Id会成为根节点的属性，Name对应的节点名变为UserName，Age属性不会出现在XML中。
注意事项
- 如果同时添加了JSON和XML格式化器，框架会根据请求的Accept头优先级选择返回格式，当Accept头同时包含两种格式时，默认优先返回JSON。
- 使用
AddXmlSerializerFormatters时，实体类的属性需要有公共的get和set访问器，否则无法正确序列化。 - 如果需要返回自定义的XML字符串，可以直接返回
Content结果，指定内容类型为application/xml：
[HttpGet("custom-xml")]
public IActionResult GetCustomXml()
{
string xmlContent = "<?xml version="1.0" encoding="utf-8"?><Result><Code>200</Code><Message>操作成功</Message></Result>";
return Content(xmlContent, "application/xml");
}
这种方式适合需要完全自定义XML结构的场景，不需要依赖实体类的序列化规则。
ASP.NET_CoreXMLAPI响应格式化器修改时间：2026-06-17 19:54:41