C# API版本控制方法 C#在ASP.NET Core Web API中如何实现版本控制-C#.Net教程

Microsoft.AspNetCore.Mvc.Versioning 是 ASP.NET Core 官方推荐的最稳妥版本控制方案,支持路径(/api/v1/users)、查询参数(?api-version=1.0)和请求头等多种方式,自动返回 400/406 错误,并需配合 UrlSegmentApiVersionReader、[ApiVersion] 与 [Route(“api/v{version:apiVersion}/[controller]”)] 成对使用,同时通过 IApiVersionDescriptionProvider 获取元数据以支撑 Swagger 多版本文档及运行时校验。

用 Microsoft.AspNetCore.Mvc.Versioning 做路由+查询参数版本控制最稳妥

这是目前 ASP.NET Core 官方推荐、社区最成熟的方案,支持 URL 路径(/api/v1/users)、查询参数(/api/users?api-version=1.0)、请求头(api-version: 1.0)等多种方式,且能自动返回 400 Bad Request 或 406 Not Acceptable 提示缺失/不支持的版本。

安装 NuGet 包:Microsoft.AspNetCore.Mvc.Versioning(注意不是过时的 Microsoft.AspNet.WebApi.Versioning)。

在 Program.cs 中注册服务:

builder.Services.AddApiVersioning(options =>
{
    options.DefaultApiVersion = new ApiVersion(1, 0);
    options.AssumeDefaultVersionWhenUnspecified = true;
    options.ReportApiVersions = true;
    options.ApiVersionReader = new UrlSegmentApiVersionReader(); // 支持 /v1/ 路由
});

关键点:

  • UrlSegmentApiVersionReader 启用路径段版本(如 /api/v1/users),需配合路由模板使用
  • QueryStringApiVersionReader 启用 ?api-version=1.0,可与前者共存
  • AssumeDefaultVersionWhenUnspecified = true 表示没传版本时默认走 DefaultApiVersion,否则会直接 400
  • ReportApiVersions = true 会在响应头加 api-supported-versions 和 api-deprecated-versions

[ApiVersion] 和 [MapToApiVersion] 必须成对使用才能路由到正确 Controller

只加 [ApiVersion("1.0")] 不够,ASP.NET Core 不会自动把 /v1/users 映射到带该特性的 Controller —— 你还得显式告诉路由系统“这个 Controller 只响应 v1”。

正确写法是:在 Controller 上同时标注 [ApiVersion] 和 [Route],并确保路由模板含版本段(如 v{version:apiVersion}):

[ApiVersion("1.0")]
[Route("api/v{version:apiVersion}/[controller]")]
[ApiController]
public class UsersController : ControllerBase
{
    [HttpGet] public IActionResult Get() => Ok("v1");
}

如果想让同一 Controller 支持多个版本(比如 v1 和 v2 接口逻辑一致),可以叠加多个 [ApiVersion]:

[ApiVersion("1.0")]
[ApiVersion("2.0")]
[Route("api/v{version:apiVersion}/[controller]")]
public class UsersController : ControllerBase { ... }

但更常见的是拆成不同 Controller,用 [MapToApiVersion("2.0")] 显式绑定:

夏夕资源网专注于CMS网站模板,主流语言整站网站源码下载,网站建设相关教程分享,好用的软件素材整合下载,提供一站式便捷自助服务。
1. 本站所有资源来源于用户上传和网络,如有侵权请邮件联系站长!
2. 分享目的仅供大家学习和交流,您必须在下载后24小时内删除!
3. 不得使用于非法商业用途,不得违反国家法律。否则后果自负!
4. 本站提供的源码、模板、插件等等其他资源,都不包含技术服务请大家谅解!
5. 如有链接无法下载、失效或广告,请联系管理员处理!
6. 本站资源售价只是赞助,收取费用仅维持本站的日常运营所需!
7. 如遇到加密压缩包,默认解压密码为"zy.lucklyus.top",如遇到无法解压的请联系管理员!
夏夕资源网-网站模板_免费源码_资源素材 » C# API版本控制方法 C#在ASP.NET Core Web API中如何实现版本控制-C#.Net教程
在线时间:12:00 - 22:00
关注微信公众号:微信公众号
站长邮箱:[email protected]
  • 运营天数: 1393+
  • 资源总数: 47989+
  • 用户总数: 1+
  • 今日更新: 0+
  • 访问次数: 4026584+
  • 本周更新: 0+
  • 最后更新: 2026-03-16

本站指数

×
  • 运营天数: 1393+
  • 资源总数: 47989+
  • 用户总数: 1+
  • 今日更新: 0+
  • 访问次数: 4026584+
  • 本周更新: 0+
  • 最后更新: 2026-03-16