.net core 杂记:WebAPI的XML请求和响应

通常状况下,restfult api  进行数据返回或模型绑定,默认json格式会比较常见和方便,固然偶尔也会须要以XML格式的要求web

对于返回XML,普一般见的方式就是在每一个aciton方法进行诸如XmlFormatter此类的序列化处理,json

而对于接收XML,则是进行一些额外的XML解析操做或反序列化处理。api

下面记录和学习较为便捷的WebAPI的XML请求和响应处理使用,不喜勿喷,有错请指教。restful

.net core 版本:2.2app

添加XML格式支持

一、安装 Microsoft.AspNetCore.Mvc.Formatters.Xml NuGet 包post

二、再Startup.ConfigureServices 中调用 AddXmlSerializerFormatters 来配置对 System.Xml.Serialization.XmlSerializer的 实现。学习

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2).AddXmlSerializerFormatters();
}

响应XML数据

想再Action层面、Controller层面或全局范围内指定特定操做响应XML格式,只需添加 [Produces] 过滤器,会自行处理成xml格式响应,无需再进行其余繁杂的处理步骤spa

以下指定Action方法响应XML格式:.net

[HttpGet("getstudent/{id}")]
[Produces("application/xml")]
public Student GetStudent(int id)
{
    var obj = new Student
    {
        Age = 12,
        Name = "123123"
    };
    return obj;
}

将直接返回以下:rest

 XML请求

 XML格式数据请求则使用[Consumes]

 以下代码:

下面示例以XML格式请求,程序会自动解析并绑定Student模型类,返回此对象的json格式(webapi 默认返回的格式)

[HttpPost("poststudent")]
[Consumes("application/xml")]
public Student PostStudent(Student obj)
{
    return obj;
}

结果以下:

相关文章
相关标签/搜索