ASP.NET Core 内容协商详解（手把手教你实现 Web API 多格式响应）

在 ASP.NET Core 中启用内容协商

默认情况下，ASP.NET Core Web API 已支持 JSON 格式的内容协商。但如果你希望支持更多格式（如 XML），需要手动配置。

步骤 1：创建一个简单的 Web API 项目

使用 .NET CLI 创建新项目：

dotnet new webapi -n MyContentNegotiationAppcd MyContentNegotiationApp

步骤 2：配置支持 XML 格式

打开 Program.cs 文件，在服务注册部分添加对 XML 序列化器的支持：

var builder = WebApplication.CreateBuilder(args);// 添加控制器服务，并配置内容协商支持 XMLbuilder.Services.AddControllers()    .AddXmlSerializerFormatters(); // 启用 XML 支持var app = builder.Build();app.MapControllers();app.Run();

步骤 3：编写一个测试控制器

在 Controllers 文件夹下创建 ProductsController.cs：

using Microsoft.AspNetCore.Mvc;[ApiController][Route("[controller]")]public class ProductsController : ControllerBase{    [HttpGet]    public IActionResult GetProducts()    {        var products = new[]        {            new { Id = 1, Name = "笔记本电脑", Price = 5999 },            new { Id = 2, Name = "无线鼠标", Price = 89 }        };        return Ok(products);    }}

测试内容协商效果

启动应用后，你可以使用 Postman 或 curl 测试不同 Accept 头的请求：

• 请求 JSON：
  curl -H "Accept: application/json" https://localhost:5001/products
• 请求 XML：
  curl -H "Accept: application/xml" https://localhost:5001/products

你会发现，服务器会根据 Accept 请求头自动返回对应格式的数据！这就是 Web API 内容协商 的强大之处。

常见问题与最佳实践

Q：如果客户端没有指定 Accept 头怎么办？
A：ASP.NET Core 默认使用 JSON 作为首选格式。

Q：能否强制只返回 JSON？
A：可以。在 AddControllers() 中不调用 AddXmlSerializerFormatters() 即可。

此外，为了提升 ASP.NET Core 响应格式 的灵活性，建议始终让 API 支持多种格式，以适应不同客户端（如移动端、Web 前端、第三方系统）的需求。

总结

通过本教程，你已经掌握了如何在 ASP.NET Core 中实现内容协商，让你的 Web API 能够智能地响应不同格式的请求。无论你是构建内部系统还是对外提供 API 服务，这项技能都至关重要。

记住关键词：ASP.NET Core 内容协商、Web API 内容协商、C# 内容协商教程 和 ASP.NET Core 响应格式——它们是你深入学习 Web 开发的重要基石！