ASP.NET Core 3.1：Accept 和 Content-Type | 向 Web API 添加 XML 支持

最新推荐文章于 2025-10-15 10:48:41 发布

原创最新推荐文章于 2025-10-15 10:48:41 发布 · 1.3k 阅读

21 ·

CC 4.0 BY-SA版权

文章标签：

#.NetCore

.Net Core 专栏收录该内容

165 篇文章

订阅专栏

默认情况下，当我们在 ASP.NET Core 中创建 Web API 时，它配置为使用 JSON。这个想法是，不同技术的不同客户端可以使用 JSON 格式与我们的应用程序通信，发送和接收信息。但是，某些 API 客户端可能更喜欢使用其他格式，例如 XML。

我们将配置一个 Web API 来支持 XML。此外，我们将讨论客户端如何以 JSON 和 XML 格式请求信息。我们将看到 Accept 和 Content-Type 标头，并讨论内容协商。

准备项目

我们要做的第一件事是在 ASP.NET Core 3.1 中创建一个 Web API。默认情况下，我们会得到一个名为WeatherForecastController的控制器。我们可以在其中添加一个 Post 方法，该方法将接收WeatherForecast的实例。最后，该类应如下所示：

WeatherForecastController.cs：

using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;

namespace WebAPIJSONXML.Controllers
{
[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
private static readonly string[] Summaries = new[]
{
"Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
};

private readonly ILogger<WeatherForecastController> _logger;

public WeatherForecastController(ILogger<WeatherForecastController> logger)
{
_logger = logger;
}

[HttpGet]
public IEnumerable<WeatherForecast> Get()
{
var rng = new Random();
return Enumerable.Range(1, 5).Select(index => new WeatherForecast
{
Date = DateTime.Now.AddDays(index),
TemperatureC = rng.Next(-20, 55),
Summary = Summaries[rng.Next(Summaries.Length)]
})
.ToArray();
}

[HttpPost]
public ActionResult Post(WeatherForecast forecast)
{
// Save the weather…

return Ok();
}
}
}

为了以 XML 格式从我们的 Web API 接收和发送数据，我们需要在 Startup 类中配置相应的服务。幸运的是，这就像调用 Startup 类中的方法一样简单。该方法称为AddXmlDataContractSerializerFormatters，我们可以按如下方式使用它：

Startup.cs：

public void ConfigureServices(IServiceCollection services)
{
services.AddControllers().AddXmlDataContractSerializerFormatters();
}

接收 XML 格式的数据 – 接受

现在我们已经创建并配置了 Web API，我们就可以以 JSON 格式从中接收数据了。如果我们运行 Web API 并使用 Postman 调用它，您很可能会获得 JSON 格式的数据。这是因为 JSON 是使用的默认格式。我们如何表明我们想要其他格式的数据？使用 Accept 标头。

根据MDN的说法：

Accept 请求 HTTP 标头通告客户端能够理解哪些内容类型（以 MIME 类型表示）。

这里的想法是，通过这个标头，我们可以向 Web API 指示我们想要返回给我们的数据类型，无论是 JSON (application/json)、XML (application/xml) 还是其他。application/json 和 application/xml 值是媒体类型或 MIME 类型的示例。

在 Postman 中，我们可以使用 Headers 选项卡来指示我们想要返回给我们的媒体类型：

这样，Web API 将以 JSON 格式返回响应：

Response.json：

[
{
"date": "2020-01-21T14:53:53.35732-04:00",
"temperatureC": 21,
"temperatureF": 69,
"summary": "Scorching"
},
{
"date": "2020-01-22T14:53:53.3573213-04:00",
"temperatureC": 1,
"temperatureF": 33,
"summary": "Freezing"
}
…
]

但是，如果将Accept值更改为“application / xml”，那么我们将得到XML格式的答案：

Response.xml：

前面的XML结构中，不可缺少的一个部分是“xmlns=” http://schemas.datacontract.org/2004/07/WebAPIJSONXML” ;，这是表示XML结构的方式。