目录

• 需求
• 目标
• 原理与思路
• 实现
• 添加Nuget Package并配置服务
• 实现API版本控制
• 一点扩展
• 总结

需求 API接口版本管理，对于一些规模稍大的企业应用来说，是经常需要关注的一大需求。尽管我们的示例程序TodoList很简单，但是我们也可以通过这个应用程序，来实践一下如何管理API接口版本。

目标 实现API接口版本管理。

原理与思路 要实现API版本管理，我们需要这个库：Microsoft.AspNetCore.Mvc.Versioning。它提供了.NET Web项目接口的版本管理功能。

实现
添加Nuget Package并配置服务
向Api项目中添加Microsoft.AspNetCore.Mvc.Versioning包。并添加一个扩展方法：
ApiServiceExtensions.cs

using Microsoft.AspNetCore.Mvc; namespace TodoList.Api.Extensions; public static class ApiServiceExtensions{public static void ConfigureApiVersioning(this IServiceCollection services){services.AddApiVersioning(options =>{// 向响应头中添加API版本信息options.ReportApiVersions = true; // 如果客户端不显式指定API版本，则使用默认版本options.AssumeDefaultVersionWhenUnspecified = true; // 配置默认版本为1.0options.DefaultApiVersion = new ApiVersion(1, 0); }); }}

在Program中调用：
Program.cs

// 省略其他...builder.ConfigureLog(); builder.Services.ConfigureApiVersioning();

实现API版本控制
方法1: 添加ApiVersion属性
【.NET|.NET 6开发TodoList应用之实现API版本控制】我们复制一份TodoItemController到新文件TodoItemV2Controller并修改类名和构造函数，其他保持原样。为了给Controller标记对应的API版本号，我们分别向两个Controller上添加属性：

[ApiVersion("2.0")][Route("/todo-item")][ApiController]public class TodoItemV2Controller : ControllerBase{private readonly IMediator _mediator; // 省略其他...}

以及

[ApiVersion("1.0")][Route("/todo-item")][ApiController]public class TodoItemController : ControllerBase{private readonly IMediator _mediator; // 省略其他..}

验证1: 请求中不添加任何API版本相关字段
启动Api项目，执行查询TodoItem的请求：
请求

文章图片

-** 响应**
日志输出：

文章图片

结果返回：

文章图片

以及响应头信息中包含的api-supported-versions：

文章图片

验证2: 请求中添加查询字符串api-version
启动Api项目，执行查询TodoItem的请求：
请求

文章图片

响应
日志输出：

文章图片

结果返回（可以自己尝试修改内部逻辑，这里我懒了没改实现，不过从日志已经能看出请求确实进入了V2版本的Controller）：

文章图片

以及响应头信息中包含的api-supported-versions

文章图片

方法2: 通过请求头携带API版本信息
为了实现这一点，需要在ConfigureApiVersioning中增加配置：
ApiServiceExtensions.cs

// 省略其他...// 指定请求头中携带用于指定API版本信息的字段options.ApiVersionReader = new HeaderApiVersionReader("api-version");

验证3: 通过请求头携带API版本信息
启动Api项目，执行查询TodoItem的请求：
请求

文章图片

响应日志输出：

文章图片

返回结果就不继续贴了，以及响应头信息中包含的api-supported-versions

文章图片

方法3: 通过URL路径访问对应的版本
除了这种之外的以上几种方法，都不需要修改接口的URI，而这种方式需要修改URI路径。我们在两个Controller上修改URI如下：

[ApiVersion("2.0")][Route("/{v:apiVersion}/todo-item")][ApiController]// 省略其他...

验证4: 通过URI路径选择API版本
启动Api项目，执行查询TodoItem的请求：
请求

文章图片

响应日志输出：

文章图片

返回结果就不继续贴了，以及响应头信息中包含的api-supported-versions：

文章图片


一点扩展 有的时候我们需要标记一个版本的请求为deprecated，但是还不想完全删除这个Controller，可以用下面的方式进行标记，这样返回头中会指出这个版本的API已经处于deprecated状态了。

[ApiVersion("2.0", Deprecated = true)][Route("/{v:apiVersion}/todo-item")][ApiController]// 省略其他...

或者在ConfigureApiVersioning中使用Convention进行标记：

// 省略其他...// 使用Convention标记deprecatedoptions.Conventions.Controller().HasDeprecatedApiVersion(new ApiVersion(2, 0));

我们再请求2.0版本的API时，仍然可以获取数据，但是得到的返回头中信息如下：

文章图片

对比使用Convention方式标记的返回头

文章图片


总结 在本文中我们使用多种方式实现了管理API版本的需求，可以根据具体的需要选择一种进行实现。
以上就是.NET 6开发TodoList应用之实现API版本控制的详细内容，更多关于.NET 6实现API版本控制的资料请关注脚本之家其它相关文章！

推荐阅读

• 

  手把手教你开启小E防火墙
• 

  职场沟通核心思路
• 

  峰回路转的意思及造句
• 

  学而优则仕的意思是什么意思 学而优则仕的意思是什么
• 

  贷款年利率和月利率有什么区别
• 

  科学发现和技术发明的基本过程
• 

  mysql数据怎么重命名 mysql怎么重命名数据库
• 

  基坑淤泥流沙泉眼处理方法
• 

  朋友们有没有好用的桌面整理软件,现在用的这个不太好用？
• 

  通过Appium获取Android app中webview
• 

  如果不用微信共享,怎样能找到对方的位置？
• 

  眼镜tr材质是什么 tr眼镜框是什么材质
• 

  哪里可以买vx小号 全新微信号2元一个
• 

  平台的流程分析,HAZOP分析流程
• 

  你若不伤，岁月无恙
• 

  窝蛋腊肠煲仔饭的做法 怎样做窝蛋腊肠煲仔饭
• 

  双引号怎么打出来 双引号怎么打 电脑键盘
• 

  农产品电商平台 是什么类型 农产品电商平台 是什么，农产品电商平台 是什么意思
• 

  兰花什么品种好
• 

  解读大豆油新国标 大豆油国家标准

• 分析服务实时概览数据助力开发者数据运营
• 低代码开发平台期望达成目标有哪些（）
• 开发并发布依赖包，作为工具包供别人npm|开发并发布依赖包，作为工具包供别人npm install
• Delphi|RAD Studio Delphi C++ Builder 2020年11月开发路线图PPT（研发Delphi WebAssembly编译器）
• 开发工具|总体上说,是c++ builder胜于VC++,DELPHI是最好
• 开发语言|C++ Builder与Visual C++孰优孰劣
• it|.Net Core之选项模式Options使用
• 苹果、微软、Google|苹果、微软、Google 和 Mozilla 共同合作，改进跨浏览器的扩展开发
• 11|11 个对开发有帮助的 JS 技巧
• 浅议开发者面临的信息偏差影响因素