

新闻资讯
技术学院推荐使用 Microsoft.AspNetCore.Mvc.Versioning 包实现 ASP.NET Core API 版本控制,支持 URL、查询参数、请求头等多种版本标识方式,需在 Program.cs 中注册服务并配置默认版本、弃用提示等,控制器通过 [ApiVersion] 特性声明版本支持。
ASP.NET Core 实现 API 版本控制,推荐使用官方支持的 Microsoft.AspNetCore.Mvc.Versioning 包,它轻量、灵活,与 MVC 深度集成,支持 URL、查询参数、请求头等多种版本标识方式。
在 Program.cs 中注册服务并配置基础行为:
AddApiVersioning 启用版本控制,设置默认版本(如 1.0)和是否报告支持的版本AssumeDefaultVersionWhenUnspecified = true,让无版本请求默认走 v1api-supported-versions 或 api-deprecated-versions 响应头,开启 ReportApiVersions = true
builder.Services.AddApiVersioning(options =>
{
options.DefaultApiVersion = new ApiVersion(1, 0);
options.AssumeDefaultVersionWhenUnspecified = true;
options.ReportApiVersions = true;
});
使用 [ApiVersion] 特性标注控制器或具体 Action,支持多个版本同时存在:
[ApiVersion("1.0")] 和 [ApiVersion("2.0")]
ProductsControllerV1 和 ProductsControllerV2,都路由到 /api/products
[MapToApiVersion("2.0")] 可将某个 Action 限定只响应 v2 请求默认通过请求头 api-version 识别,但更常见的是 URL 路径(如 /api/v1/products)或查询参数(如 /api/products?api-version=1.0):
options.ApiVersionReader = new UrlSegmentApiVersionReader();,再用 [Route("api/v{version:apiVersion}/[controller]")]
new QueryStringApiVersionReader("api-version")
api-version: 2.0
对已废弃的版本,可通过特性明确标记,并由框架自动注入响应头:
器加 [ApiVersion("1.0", Deprecated = true)]
ReportApiVersions = true 后,v1 接口响应头会包含 api-deprecated-versions: 1.0
基本上就这些。不复杂但容易忽略细节,比如忘了注册服务、没配路由模板、或多个版本控制器冲突——调试时留意日志里 ApiVersionMatcherPolicy 的匹配结果即可。