在 ASP.NET Core 中返回 XML 格式的 API 响应,需要配置 MVC 以支持 XML 序列化,并使用相应的结果类型。默认情况下,ASP.NET Core 只支持 JSON,但可以通过添加内置的 XML 输出格式器来启用 XML 支持。
1. 启用 XML 格式支持
在 Program.cs 或 Startup.cs(取决于项目结构)中,需要向 MVC 配置添加 XML 序列化支持:
builder.Services.AddControllers()
.AddXmlSerializerFormatters(); // 支持 application/xml
这行代码会注册 XmlSerializer 格式器,使控制器能够根据请求头中的 Accept: application/xml 返回 XML 数据。
2. 控制器中返回 XML 数据
定义一个简单的模型类:
public class Person
{
public int Id { get; set; }
public string Name { get; set; }
}
在控制器中返回该对象:
[ApiController]
[Route("[controller]")]
public class PeopleController : ControllerBase
{
[HttpGet("{id}")]
public IActionResult Get(int id)
{
var person = new Person { Id = id, Name = "张三" };
return Ok(person); // 自动根据 Accept 头选择格式
}
}
当客户端请求时设置 Accept: application/xml,API 就会返回 XML 格式内容:
3. 强制返回 XML(忽略请求头)
如果想无论请求头如何都返回 XML,可以使用 ContentResult 手动序列化:
using System.Xml.Serialization;
using System.IO;
// ...
[HttpGet("xml/{id}")]
public ContentResult GetXml(int id)
{
var person = new Person { Id = id, Name = "李四" };
var serializer = new XmlSerializer(typeof(Person));
using var writer = new StringWriter();
serializer.Serialize(writer, person);
return new ContentResult
{
ContentType = "application/xml",
Content = writer.ToString(),
StatusCode = 200
};
}
