讲师中心 微信公众号
AI工具推荐 视频效率加速

C#怎么创建API版本控制_C# ASP.NET Core API版本管理教程【进阶】

落杰姑娘_4173

落杰姑娘_4173

发布时间:2026-04-16 16:25:06

|

437人浏览过

|

来源于php中文网

原创

ASP.NET Core 6+需用Microsoft.AspNetCore.Mvc.Versioning实现API版本控制,仅加[ApiVersion]无效,必须配合[Route("api/v{version:apiVersion}/[controller]")]绑定URL段,且AddApiVersioning()须配置AssumeDefaultVersionWhenUnspecified、ReportApiVersions和ApiVersionReader三项关键选项。

c#怎么创建api版本控制_c# asp.net core api版本管理教程【进阶】

ASP.NET Core 6+ 原生支持 API 版本控制,不用自己解析 URL 段或手动读取 api-version 查询参数——直接用 Microsoft.AspNetCore.Mvc.Versioning,否则你写的路由逻辑、Swagger 文档、过滤器都会和版本脱节。

为什么只加 [ApiVersion("1.0")] 不生效

框架不会自动把 /api/v1/users 映射到标了 [ApiVersion("1.0")] 的控制器。它只声明“这个 Controller 支持 v1”,但没告诉路由系统“v1 对应哪段 URL”。必须配合路由模板显式绑定。

  • [Route("api/v{version:apiVersion}/[controller]")] 是最常用写法,apiVersion 是内置路由约束,能识别 v1、v2.5 等格式
  • 控制器上必须同时有 [ApiVersion("1.0")] 和匹配的 [Route],缺一不可
  • 如果想让一个 Action 只响应特定子版本(比如仅 v1.1),要用 [MapToApiVersion("1.1")],不能只靠 [ApiVersion]
  • 不加 [Route] 或路由模板里没含 {version},请求会 404,而不是 400 —— 因为根本没进版本协商流程

AddApiVersioning() 必须配置的三项关键选项

在 Program.cs 中调用 AddApiVersioning() 时,以下三个配置项直接影响行为,漏掉任一个都可能让版本控制“看起来没起作用”:

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载
  • AssumeDefaultVersionWhenUnspecified = true:客户端不传任何版本时,默认走 DefaultApiVersion(如 new ApiVersion(1, 0)),否则直接返回 400 Bad Request
  • ReportApiVersions = true:响应头里自动加 api-supported-versions 和 api-deprecated-versions,前端可据此判断兼容性
  • ApiVersionReader 要明确指定,例如 new UrlSegmentApiVersionReader()(对应 /v1/)或 new QueryStringApiVersionReader("api-version")(对应 ?api-version=1.0),多个可共存

Swagger 多版本文档生成总为空或混在一起

默认 AddSwaggerGen() 不知道哪个接口属于哪个版本,必须手动按 [ApiVersion] 属性筛选文档。否则所有接口都塞进同一个 v1 文档里,或者干脆漏掉高版本。

  • 注册多个 SwaggerDoc() 时,docName(如 "v1")必须和 [ApiVersion("1.0")] 中的版本字符串能对上(建议统一用 "v1"、"v2" 这种字符串)
  • DocInclusionPredicate 必须检查控制器类型上的 ApiVersionAttribute,不能只看 Action 方法——因为版本是按 Controller 维度声明的
  • ResolveConflictingActions 必须设为 apiDescriptions => apiDescriptions.First(),否则同一路径多版本会报“冲突”错误

同一 Controller 支持多个版本时的常见陷阱

想让 UsersController 同时处理 v1 和 v2,不是简单叠加 [ApiVersion("1.0"), ApiVersion("2.0")] 就完事。路由和 Action 层级的版本感知要一致。

  • Controller 上叠加多个 [ApiVersion] 是 OK 的,但每个对应版本都得有匹配的路由入口,比如 [Route("api/v{version:apiVersion}/users")]
  • 如果某个 Action 只适用于 v2(比如新增字段),要加 [MapToApiVersion("2.0")],否则 v1 请求也可能命中它
  • 不要在 Action 参数里再写 [FromQuery] string version 或 [FromHeader] string api_version —— 这会绕过框架的版本协商,导致过滤器、日志、监控无法感知真实版本
  • 启用 Deprecated = true(如 [ApiVersion("1.0", Deprecated = true)])后,ReportApiVersions 才会在响应头中暴露 api-deprecated-versions

最易被忽略的一点:版本控制不是“加几个特性就完事”,它是贯穿路由、模型绑定、授权、日志、OpenAPI 文档的全链路能力。一旦某处(比如自定义 IActionConstraint 或中间件)没适配 ApiVersion 上下文,版本就会在那个环节断掉。

热门AI工具

更多
创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3529

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2408

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1340

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1298

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1416

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2318

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3800

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

17775

2023.09.22

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn