ASP.NET Core3.x API版本控制的实现

前言

一般来说需要更改我们API的时候才考虑版本控制，但是我觉得我们不应该等到那时候来实现它，我们应该有一个版本策略从我们应用程序开发时就开始制定好我们的策略，我们一直遵循着这个策略进行开发。

我们其实可以通过多种方式进行实现我们API版本的控制，其实对于版本控制没有最好的方式，这完全取决于我们面向的使用者。

API版本控制类型

安装版本控制包

Install-Package Microsoft.AspNetCore.Mvc.Versioning

在Startup.cs中的ConfigureServices方法中进行版本设置，以及在控制器通过特性进行设置版本，这样可以实现版本控制。

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

options.DefaultApiVersion = new ApiVersion(1,0): 这个设置不是必须的，因为默认情况下给我们设置的是1.0，但是显式的声明出来是一个很好的习惯，当然DefaultApiVersion它会将默认的[ApiVersion("1.0")]添加到控制器上，也就是说它会隐式的绑定API版本，但是为了我们方便理解或者说方便我们后面开发建议显式的设置。 options.AssumeDefaultVersionWhenUnspecified = true:默认API版本控制需要将其属性设置为true才可以开启 options.ReportApiVersions = true:默认情况下它是禁用的，启用此选项后，来自我们API端点的响应将带有标头，告诉我们的客户端支持或不推荐使用哪个版本(api-supported-versions:1.1,2.0, api-deprecated-versions:1.0)

默认提供了四种版本控制方法：

字符串参数 通过HTTP请求头 URL方式 媒体类型（Media Type）

默认方法是使用名为api-version 的查询字符串参数。我们还可以自己定义一个版本控制规则。

API版本约束方式

字符串参数形式

services.AddApiVersioning(options => 
  options.ApiVersionReader = new QueryStringApiVersionReader("v"));

HTTP请求头

services.AddApiVersioning(options => 
  options.ApiVersionReader = new HeaderApiVersionReader("api-version"));

组合方式

services.AddApiVersioning(options => {
  options.ApiVersionReader = ApiVersionReader.Combine(
    new QueryStringApiVersionReader("v"),
    new HeaderApiVersionReader("v"));});

URL方式

services.AddApiVersioning(options => options.ApiVersionReader = 
  new UrlSegmentApiVersionReader());

我们可以更改代表版本的参数名称（例如，在上面的查询字符串方法中，我们使用字母v代替默认的api-version）。

控制器和方法中添加版本信息