0

0

C#怎么进行API版本控制 ASP.NET Core API版本管理方法

幻夢星雲

幻夢星雲

发布时间:2025-12-19 12:37:02

|

994人浏览过

|

来源于php中文网

原创

ASP.NET Core API版本控制推荐使用Microsoft.AspNetCore.Mvc.Versioning包,通过URL路径、查询参数或请求头传递版本信息,并支持弃用标记与Swagger多版本文档。

c#怎么进行api版本控制 asp.net core api版本管理方法

ASP.NET Core 中做 API 版本控制,核心是让新旧版本共存、路由可区分、客户端能明确指定要调用哪个版本。不靠改 URL 后缀(比如 /api/v2/users)硬编码,而是用更规范、可扩展的方式——推荐用 URL 路径 + 查询参数 + 请求头 三者之一或组合,并配合官方 Microsoft.AspNetCore.Mvc.Versioning 包。

用 Microsoft.AspNetCore.Mvc.Versioning 包统一管理

这是微软生态最主流、维护良好的方案。安装 NuGet 包:

Install-Package Microsoft.AspNetCore.Mvc.Versioning

Program.cs(.NET 6+)中注册服务并启用版本控制:

builder.Services.AddApiVersioning(options =>
  {
    options.DefaultApiVersion = new ApiVersion(1, 0);
    options.AssumeDefaultVersionWhenUnspecified = true;
    options.ReportApiVersions = true;
  });

关键配置说明:

  • DefaultApiVersion:没带版本时默认走 v1.0
  • AssumeDefaultVersionWhenUnspecified:允许不传版本也能访问(适合平滑过渡)
  • ReportApiVersions:响应头里返回支持的版本列表(如 api-supported-versions: 1.0, 2.0

三种常用版本定位方式(按推荐顺序)

版本信息可以从 URL、查询参数或请求头传入,框架自动识别:

  • 路径版本(最直观)GET /api/v1/usersGET /api/v2/users,控制器加特性:
    [ApiVersion("1.0")]
    [Route("api/v{version:apiVersion}/[controller]")]
  • 查询参数版本(低侵入)GET /api/users?api-version=2.0,需额外配置:
    options.ApiVersionReader = new QueryStringApiVersionReader("api-version");
  • 请求头版本(最干净)GET /api/users + Header: api-version: 2.0,配置:
    options.ApiVersionReader = new HeaderApiVersionReader("api-version");

可以同时启用多种方式,框架会按顺序尝试匹配(默认:头 > 查询 > 路径)。

为不同版本写独立控制器或动作

推荐用命名空间或控制器名区分,避免一个控制器里堆满 if-else:

来福FM
来福FM

来福 - 你的私人AI电台

下载
[ApiVersion("1.0")]
public class UsersController : ControllerBase { ... }

[ApiVersion("2.0")]
public class UsersControllerV2 : ControllerBase { ... }

或者用同一控制器、不同动作(带版本特性):

[ApiVersion("1.0")]
[HttpGet]
public IActionResult Get() { ... }

[ApiVersion("2.0")]
[HttpGet]
public IActionResult Get() { ... } // 方法名可相同,因特性路由已区分

注意:必须给每个动作明确标注 [ApiVersion],否则不会被识别为该版本入口。

处理弃用、迁移与文档一致性

版本不是只增不减。当 v1 不再维护,可标记为已弃用:

[ApiVersion("1.0", Deprecated = true)]

这样响应头会多出 api-deprecated-versions: 1.0,方便客户端感知。搭配 Swagger 时,用 Swashbuckle.AspNetCore.Versioning.Swagger 可自动生成多版本文档页,每个版本独立 UI。

另外,数据库兼容性、DTO 模型变更、中间件行为差异都要同步评估——版本控制只是入口,背后逻辑和契约才是重点。

基本上就这些。不复杂但容易忽略细节:比如忘了注册服务、没配 ApiVersionReader 导致查询参数无效、或多个同名动作没加 [ApiVersion] 而报错。用好官方包,版本管理就能清晰可控。

相关专题

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

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

178

2024.05.11

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

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

212

2025.12.18

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

744

2023.08.22

堆和栈的区别
堆和栈的区别

堆和栈的区别:1、内存分配方式不同;2、大小不同;3、数据访问方式不同;4、数据的生命周期。本专题为大家提供堆和栈的区别的相关的文章、下载、课程内容,供大家免费下载体验。

390

2023.07.18

堆和栈区别
堆和栈区别

堆(Heap)和栈(Stack)是计算机中两种常见的内存分配机制。它们在内存管理的方式、分配方式以及使用场景上有很大的区别。本文将详细介绍堆和栈的特点、区别以及各自的使用场景。php中文网给大家带来了相关的教程以及文章欢迎大家前来学习阅读。

572

2023.08.10

class在c语言中的意思
class在c语言中的意思

在C语言中,"class" 是一个关键字,用于定义一个类。想了解更多class的相关内容,可以阅读本专题下面的文章。

465

2024.01.03

python中class的含义
python中class的含义

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

13

2025.12.06

数据库三范式
数据库三范式

数据库三范式是一种设计规范,用于规范化关系型数据库中的数据结构,它通过消除冗余数据、提高数据库性能和数据一致性,提供了一种有效的数据库设计方法。本专题提供数据库三范式相关的文章、下载和课程。

346

2023.06.29

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

40

2026.01.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 2.8万人学习

Rust 教程
Rust 教程

共28课时 | 4.5万人学习

Git 教程
Git 教程

共21课时 | 2.7万人学习

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

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