0

0

ASP.NET Core如何返回XML格式的API响应

煙雲

煙雲

发布时间:2025-12-29 17:39:30

|

835人浏览过

|

来源于php中文网

原创

ASP.NET Core 默认不支持 XML 响应,需在 Program.cs 中调用 AddXmlSerializerFormatters() 注册,并在控制器方法添加 [Produces("application/xml")] 特性,客户端请求头需含 Accept: application/xml。

asp.net core如何返回xml格式的api响应

ASP.NET Core 默认不启用 XML 响应支持,需手动配置才能让 API 返回 XML 格式(如 application/xml),尤其在对接传统系统或满足特定协议要求时很有用。

启用 XML 输出格式化器

Program.cs 中注册 XML 支持:

  • 调用 AddXmlSerializerFormatters()AddXmlDataContractSerializerFormatters()
  • 前者基于 XmlSerializer,更常用;后者基于 DataContractSerializer,适合 WCF 兼容场景

示例(.NET 6+):

builder.Services.AddControllers()
    .AddXmlSerializerFormatters(); // 启用 XmlSerializer 支持

控制器返回 XML 响应

确保控制器方法返回可序列化的对象(如 POCO 类),并添加 [Produces("application/xml")] 特性声明输出类型:

[ApiController]
[Route("api/[controller]")]
public class ProductsController : ControllerBase
{
    [HttpGet]
    [Produces("application/xml")]
    public IActionResult Get() => Ok(new Product { Id = 1, Name = "Laptop" });
}

客户端需在请求头中指定 Accept: application/xml,否则仍可能返回 JSON(取决于内容协商结果)。

Z Code
Z Code

智谱AI推出的轻量级AI代码编辑器

下载

注意序列化行为和兼容性

XmlSerializer 对类成员有要求:

  • 只序列化 公共读写属性(字段不支持)
  • 类必须有无参构造函数
  • 若需自定义 XML 节点名或忽略某属性,可用 [XmlElement("CustomName")][XmlIgnore]

例如:

public class Product
{
    public int Id { get; set; }
    [XmlElement("ProductName")]
    public string Name { get; set; }
    [XmlIgnore]
    public DateTime CreatedAt { get; set; }
}

调试与验证

使用 curl 或 Postman 测试时,务必设置 Accept 请求头:

curl -H "Accept: application/xml" https://localhost:5001/api/products

若返回 406 Not Acceptable,检查是否遗漏注册 XML 格式化器,或控制器未正确标注 [Produces],或返回对象不可被 XmlSerializer 处理。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

401

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

528

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

306

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

72

2025.09.10

软件测试常用工具
软件测试常用工具

软件测试常用工具有Selenium、JUnit、Appium、JMeter、LoadRunner、Postman、TestNG、LoadUI、SoapUI、Cucumber和Robot Framework等等。测试人员可以根据具体的测试需求和技术栈选择适合的工具,提高测试效率和准确性 。

424

2023.10.13

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1846

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2080

2024.08.01

xml是什么格式的文件
xml是什么格式的文件

xml是一种纯文本格式的文件。xml指的是可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。想了解更多相关的内容,可阅读本专题下面的相关文章。

917

2024.11.28

俄罗斯搜索引擎Yandex最新官方入口网址
俄罗斯搜索引擎Yandex最新官方入口网址

Yandex官方入口网址是https://yandex.com;用户可通过网页端直连或移动端浏览器直接访问,无需登录即可使用搜索、图片、新闻、地图等全部基础功能,并支持多语种检索与静态资源精准筛选。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1

2025.12.29

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号