您现在的位置是：亿华云 > 数据库
如何实现 ASP.NET Core WebApi 的版本化
亿华云2025-10-03 06:38:51【数据库】4人已围观
简介本文转载自微信公众号「 码农读书」，作者 码农读书 。转载本文请联系 码农读书公众号。Web API 的版本化可以尽量保证在相同url情况下保留一个 api 的多个版本，通常一个 webapi 会有多
本文转载自微信公众号「 码农读书」，何实化作者 码农读书 。版本转载本文请联系 码农读书公众号。何实化
Web API 的版本版本化可以尽量保证在相同url情况下保留一个 api 的多个版本，通常一个 webapi 会有多个client，何实化这些client包括：app，版本web，何实化html5，版本crawl 等等同构或者异构的何实化平台，当 api 升级之后，版本往往升级前的何实化 api 也得保留，当维护两个api的版本时候就是一个不小的挑战，毕竟还是何实化存在一些 client 用户需要访问老的api，这时候就需要将 webapi 版本化。版本
安装 Versioning 包
要想使用 webapi 的亿华云何实化版本化功能，需要用 nuget 引用 Microsoft.AspNetCore.Mvc.Versioning 包，还可以通过 Visual Studio 2019 的 NuGet package manager 可视化界面安装 或者 通过 NuGet package manager 命令行工具输入以下命令：
dotnet add package Microsoft.AspNetCore.Mvc.Versioning启动 API 版本化
当包成功添加到项目之后，接下来就可以在 Startup.ConfigureServices 中将 ApiVersioning 注入到容器中，如下代码所示：
public class Startup { public void ConfigureServices(IServiceCollection services) { services.AddControllers(); services.AddApiVersioning(); } }在调用 AddApiVersioning() 的时候记得 using Microsoft.AspNetCore.Mvc.Versioning，除了这个默认方法，还可以做一些全局配置，如下代码所示：
public class Startup { public void ConfigureServices(IServiceCollection services) { services.AddControllers(); services.AddApiVersioning(v => { v.ReportApiVersions = true; v.AssumeDefaultVersionWhenUnspecified = true; v.DefaultApiVersion = new ApiVersion(1, 0); }); } }使用 QueryString 指定版本号
先来看一下代码，考虑如下的 api。
[ApiController] [ApiVersion("2.0")] [Route("api/[controller]")] public class WeatherForecastController : ControllerBase { private static readonly string[] Summaries = new[] { "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching" }; [HttpGet] public IEnumerable<WeatherForecast> Get() { var rng = new Random(); return Enumerable.Range(1, 5).Select(index => new WeatherForecast { Date = DateTime.Now.AddDays(index), TemperatureC = rng.Next(-20, 55), Summary = Summaries[rng.Next(Summaries.Length)] }) .ToArray(); } }从代码中可以看到，我在 WeatherForecastController 上标记了该 Controller 是 v2.0 版本，接下来如何访问呢?可以通过如下链接: http://localhost:61582/api/weatherforecast?api-version=2.0
看到这里，有些朋友就有疑问了，v2.0 的 Get 是有了，那 v1.0 的 Get 怎么访问呢?实际开发中的做法是云服务器提供商这样的，会用两个命名空间来表示相应的版本号，可以看如下代码：
namespace WebApplication6.Controllers.v1 { [ApiController] [ApiVersion("1.0")] [Route("api/[controller]")] public class WeatherForecastController : ControllerBase { private static readonly string[] Summaries = new[] { "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching" }; private readonly ILogger<WeatherForecastController> _logger; public WeatherForecastController(ILogger<WeatherForecastController> logger) { _logger = logger; } [HttpGet] public IEnumerable<WeatherForecast> Get() { var rng = new Random(); return Enumerable.Range(1, 5).Select(index => new WeatherForecast { Date = DateTime.Now.AddDays(index), TemperatureC = rng.Next(-20, 55), Summary = Summaries[rng.Next(Summaries.Length)] }) .ToArray(); } } } namespace WebApplication6.Controllers.v2 { [ApiController] [ApiVersion("2.0")] [Route("api/[controller]")] public class WeatherForecastController : ControllerBase { private static readonly string[] Summaries = new[] { "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching" }; private readonly ILogger<WeatherForecastController> _logger; public WeatherForecastController(ILogger<WeatherForecastController> logger) { _logger = logger; } [HttpGet] public IEnumerable<WeatherForecast> Get() { var rng = new Random(); return Enumerable.Range(1, 5).Select(index => new WeatherForecast { Date = DateTime.Now.AddDays(index), TemperatureC = rng.Next(-20, 55), Summary = Summaries[rng.Next(Summaries.Length)] }) .ToArray(); } } }从上面代码可以看到 WebApplication6.Controllers.v1 表示版本 v1.0 ， WebApplication6.Controllers.v2 表示版本 v2.0，接下来依次浏览这两个url。
使用 routes 指定版本号
很显然使用 QueryString 的方式不是很优雅也不符合 Restful 规范，接下来看一下如何通过 Route 改造，考虑下面的类，请注意我是如何在 route 中进行版本化的。
[ApiController] [ApiVersion("1.0")] [Route("api/v{ version:apiVersion}/[controller]")] public class WeatherForecastController : ControllerBase { private static readonly string[] Summaries = new[] { "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching" }; [HttpGet] public IEnumerable<WeatherForecast> Get() { var rng = new Random(); return Enumerable.Range(1, 5).Select(index => new WeatherForecast { Date = DateTime.Now.AddDays(index), TemperatureC = rng.Next(-20, 55), Summary = Summaries[rng.Next(Summaries.Length)] }) .ToArray(); } }在这里，我将 [Route("api/[controller]")] 替换成了 [Route("api/v{ version:apiVersion}/[controller]")]，接下来将项目跑起来，如下图所示：
忽略 API 版本
在 API 版本化时，有些 API 可能只有一个版本的需求，这时候可以使用 ApiVersionNeutral 特性来忽视版本化，高防服务器如下代码所示：
[ApiVersionNeutral] [Route("api/[controller]")] [ApiController] public class WeatherForecastController : ControllerBase { private static readonly string[] Summaries = new[] { "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching" }; [HttpGet] public IEnumerable<WeatherForecast> Get() { var rng = new Random(); return Enumerable.Range(1, 5).Select(index => new WeatherForecast { Date = DateTime.Now.AddDays(index), TemperatureC = rng.Next(-20, 55), Summary = Summaries[rng.Next(Summaries.Length)] }) .ToArray(); } }译文链接：https://www.infoworld.com/article/3433156/advanced-versioning-in-aspnet-core-web-api.html
很赞哦!（112）
