0

0

ASP.NET Core怎么实现API版本控制 ASP.NET Core API Versioning教程

月夜之吻

月夜之吻

发布时间:2025-12-25 08:16:02

|

156人浏览过

|

来源于php中文网

原创

推荐使用 Microsoft.AspNetCore.Mvc.Versioning 包实现 ASP.NET Core API 版本控制,支持 URL、查询参数、请求头等多种版本标识方式,需在 Program.cs 中注册服务并配置默认版本、弃用提示等,控制器通过 [ApiVersion] 特性声明版本支持。

asp.net core怎么实现api版本控制 asp.net core api versioning教程

ASP.NET Core 实现 API 版本控制,推荐使用官方支持的 Microsoft.AspNetCore.Mvc.Versioning 包,它轻量、灵活,与 MVC 深度集成,支持 URL、查询参数、请求头等多种版本标识方式。

安装并启用版本控制服务

Program.cs 中注册服务并配置基础行为:

  • 通过 AddApiVersioning 启用版本控制,设置默认版本(如 1.0)和是否报告支持的版本
  • 可选启用 AssumeDefaultVersionWhenUnspecified = true,让无版本请求默认走 v1
  • 若需返回 api-supported-versionsapi-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")]
  • 不同控制器处理不同版本:如 ProductsControllerV1ProductsControllerV2,都路由/api/products
  • 配合 [MapToApiVersion("2.0")] 可将某个 Action 限定只响应 v2 请求
注意:必须为每个版本提供至少一个匹配的 endpoint,否则会返回 400 或 404。

选择版本识别方式(URL / Query / Header)

默认通过请求头 api-version 识别,但更常见的是 URL 路径(如 /api/v1/products)或查询参数(如 /api/products?api-version=1.0):

Digram
Digram

让Figma更好用的AI神器

下载
  • URL 路径:配置 options.ApiVersionReader = new UrlSegmentApiVersionReader();,再用 [Route("api/v{version:apiVersion}/[controller]")]
  • 查询参数:用 new QueryStringApiVersionReader("api-version")
  • 请求头:默认即支持,客户端传 api-version: 2.0
  • 也可组合使用,如优先读 URL,降级读 Header

处理弃用与兼容性提示

对已废弃的版本,可通过特性明确标记,并由框架自动注入响应头:

  • 给控制器加 [ApiVersion("1.0", Deprecated = true)]
  • 启用 ReportApiVersions = true 后,v1 接口响应头会包含 api-deprecated-versions: 1.0
  • 客户端可根据该头决定是否提醒用户升级,服务端无需手动拦截或返回特殊状态码

基本上就这些。不复杂但容易忽略细节,比如忘了注册服务、没配路由模板、或多个版本控制器冲突——调试时留意日志里 ApiVersionMatcherPolicy 的匹配结果即可。

相关专题

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

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

980

2023.10.19

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

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

36

2025.10.17

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

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

461

2023.10.30

JavaScript ES6新特性
JavaScript ES6新特性

ES6是JavaScript的根本性升级,引入let/const实现块级作用域、箭头函数解决this绑定问题、解构赋值与模板字符串简化数据处理、对象简写与模块化提升代码可读性与组织性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

0

2025.12.24

php框架基础知识汇总
php框架基础知识汇总

php框架是构建web应用程序的架构,提供工具和功能,以简化开发过程。选择合适的框架取决于项目需求和技能水平。实战案例展示了使用laravel构建博客的步骤,包括安装、创建模型、定义路由、编写控制器和呈现视图。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1

2025.12.24

Word 字间距调整方法汇总
Word 字间距调整方法汇总

本专题整合了Word字间距调整方法,阅读下面的文章了解更详细操作。

2

2025.12.24

任务管理器教程
任务管理器教程

本专题整合了任务管理器相关教程,阅读下面的文章了解更多详细操作。

2

2025.12.24

AppleID格式
AppleID格式

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

2

2025.12.24

csgo视频观看入口合集
csgo视频观看入口合集

本专题整合了csgo观看入口合集,阅读下面的文章了知道更多入口地址。

29

2025.12.24

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Git 教程
Git 教程

共21课时 | 2.2万人学习

SciPy 教程
SciPy 教程

共10课时 | 0.9万人学习

Kotlin 教程
Kotlin 教程

共23课时 | 2万人学习

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

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