0

0

C# 在ASP.NET Core中如何返回xml格式的API响应

畫卷琴夢

畫卷琴夢

发布时间:2025-10-28 12:12:02

|

452人浏览过

|

来源于php中文网

原创

首先在Program.cs中添加AddXmlSerializerFormatters()以启用XML支持,接着定义公共模型类并确保属性具有getter/setter;控制器使用Ok结果返回对象,框架根据Accept头自动选择JSON或XML格式;若需强制返回XML,可手动使用XmlSerializer序列化并返回ContentResult,设置ContentType为application/xml;注意XML序列化不支持复杂类型或循环引用,且性能较JSON差,应按需启用。

c# 在asp.net core中如何返回xml格式的api响应

在 ASP.NET Core 中返回 XML 格式的 API 响应,需要配置 MVC 以支持 XML 序列化,并使用相应的结果类型。默认情况下,ASP.NET Core 只支持 JSON,但可以通过添加内置的 XML 输出格式器来启用 XML 支持。

1. 启用 XML 格式支持

Program.csStartup.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 格式内容:

知料万语
知料万语

知料万语—AI论文写作,AI论文助手

下载

  1

  张三

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

    };

}

4. 注意事项

  • 确保类和属性是公共的,且具有 getter/setter,否则 XmlSerializer 无法序列化
  • 不支持复杂类型或循环引用,如需更灵活控制可考虑使用 DataContractSerializer
  • 若同时支持 JSON 和 XML,客户端通过 Accept 头决定返回格式
  • 性能上 XML 比 JSON 稍慢,体积更大,按需启用
基本上就这些。只要注册了 XML 格式器,ASP.NET Core 就能自动处理内容协商,返回正确的 XML 响应。

相关专题

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

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

417

2023.08.07

json是什么
json是什么

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

533

2023.08.23

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

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

311

2023.10.13

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

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

76

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

358

2023.08.02

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

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

1897

2024.04.01

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

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

2088

2024.08.01

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

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

1040

2024.11.28

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C# 教程
C# 教程

共94课时 | 7.4万人学习

C 教程
C 教程

共75课时 | 4.2万人学习

C++教程
C++教程

共115课时 | 13.5万人学习

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

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