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,支持多个版本同时存在:

Img.Upscaler
Img.Upscaler

免费的AI图片放大工具

下载
  • 单个控制器支持多版本:加多个 [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):

  • 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 的匹配结果即可。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

1825

2023.10.19

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

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

594

2025.10.17

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

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

2347

2025.12.29

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

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

45

2026.01.19

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

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

510

2023.10.30

Rust内存安全机制与所有权模型深度实践
Rust内存安全机制与所有权模型深度实践

本专题围绕 Rust 语言核心特性展开,深入讲解所有权机制、借用规则、生命周期管理以及智能指针等关键概念。通过系统级开发案例,分析内存安全保障原理与零成本抽象优势,并结合并发场景讲解 Send 与 Sync 特性实现机制。帮助开发者真正理解 Rust 的设计哲学,掌握在高性能与安全性并重场景中的工程实践能力。

2

2026.03.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

58

2026.03.04

AI安装教程大全
AI安装教程大全

2026最全AI工具安装教程专题:包含各版本AI绘图、AI视频、智能办公软件的本地化部署手册。全篇零基础友好,附带最新模型下载地址、一键安装脚本及常见报错修复方案。每日更新,收藏这一篇就够了,让AI安装不再报错!

31

2026.03.04

Swift iOS架构设计与MVVM模式实战
Swift iOS架构设计与MVVM模式实战

本专题聚焦 Swift 在 iOS 应用架构设计中的实践,系统讲解 MVVM 模式的核心思想、数据绑定机制、模块拆分策略以及组件化开发方法。内容涵盖网络层封装、状态管理、依赖注入与性能优化技巧。通过完整项目案例,帮助开发者构建结构清晰、可维护性强的 iOS 应用架构体系。

59

2026.03.03

热门下载

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

精品课程

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

共21课时 | 4万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.8万人学习

Kotlin 教程
Kotlin 教程

共23课时 | 4.2万人学习

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

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