0

0

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

月夜之吻

月夜之吻

发布时间:2026-02-06 09:16:50

|

549人浏览过

|

来源于php中文网

原创

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 多版本文档及运行时校验。

c# api版本控制方法 c#在asp.net core web api中如何实现版本控制

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

这是目前 ASP.NET Core 官方推荐、社区最成熟的方案,支持 URL 路径(/api/v1/users)、查询参数(/api/users?api-version=1.0)、请求头(api-version: 1.0)等多种方式,且能自动返回 400 Bad Request406 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-versionsapi-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")] 显式绑定:

Motiff
Motiff

Motiff是由猿辅导旗下的一款界面设计工具,定位为“AI时代设计工具”

下载
[ApiVersion("2.0")]
[MapToApiVersion("2.0")]
[Route("api/v{version:apiVersion}/[controller]")]
public class UsersControllerV2 : ControllerBase { ... }

否则会出现「请求 /v2/users 却进了 v1 Controller」或「404」—— 因为路由引擎没被告知哪个 Controller 对应哪个版本。

升级到 v3+ 时 IApiVersionDescriptionProvider 是获取所有版本元数据的唯一入口

生成 Swagger 文档、构建版本切换 UI、做运行时版本校验时,不能靠硬编码或反射 Controller 列表。必须通过 DI 获取 IApiVersionDescriptionProvider 实例:

var provider = app.Services.GetRequiredService();
foreach (var description in provider.ApiVersionDescriptions)
{
    Console.WriteLine($"Version: {description.ApiVersion}, IsDeprecated: {description.IsDeprecated}");
}

这个对象在 AddApiVersioning() 后自动注册,包含全部已注册的 API 版本、是否弃用、是否稳定等信息。漏掉这步,Swagger 就只能显示默认版本,或者根本无法区分 v1/v2 的文档分组。

常见错误:

  • 手动拼接 /v1/ 路由但没配 UrlSegmentApiVersionReader → 请求 404
  • Controller 有 [ApiVersion] 但路由没写 v{version:apiVersion} → 版本匹配失效
  • 启用 ReportApiVersions前端没读响应头 → 无法自动发现可用版本
  • Swagger 配合 Swashbuckle.AspNetCore 时,没调用 options.SwaggerDoc(...) 为每个版本单独注册 → 文档混在一起或丢失

弃用旧版本时 [ApiVersion("1.0", Deprecated = true)] 不会自动拦截请求

标记 Deprecated = true 只影响文档生成(Swagger 会加删除线)和响应头(api-deprecated-versions),不会阻止客户端调用。真正要停用 v1,必须配合 IApiVersionSelector 自定义策略,或在中间件里检查 HttpContext.GetRequestedApiVersion() 并返回 501 Not Implemented

例如,在 Program.cs 注册自定义选择器:

options.ApiVersionSelector = new CurrentImplementationApiVersionSelector(options);

然后继承 IApiVersionSelector,在 SelectVersion 方法中判断版本是否已下线。否则,哪怕你标了 Deprecated = true,v1 接口依然照常工作——这点容易被忽略,导致技术债越积越多。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

179

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

222

2025.12.18

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1261

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

275

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2196

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

34

2026.01.19

vsd文件打开方法
vsd文件打开方法

vsd文件打开方法有使用Microsoft Visio软件、使用Microsoft Visio查看器、转换为其他格式等。想了解更多vsd文件相关内容,可以阅读本专题下面的文章。

492

2023.10.30

微信网页版文件传输助手教程合集
微信网页版文件传输助手教程合集

本专题整合了微信网页版文件传输助手教程、入口等等内容,阅读专题下面的文章了解更多详细内容。

15

2026.02.04

微信文件过期恢复教程
微信文件过期恢复教程

本专题整合了微信文件过期恢复方法、技巧教程,阅读专题下面的文章了解更多详细内容。

10

2026.02.04

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Node.js 教程
Node.js 教程

共57课时 | 10.4万人学习

CSS3 教程
CSS3 教程

共18课时 | 5.2万人学习

Vue 教程
Vue 教程

共42课时 | 7.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号