需求

API接口版本管理，對于一些規(guī)模稍大的企業(yè)應(yīng)用來說，是經(jīng)常需要關(guān)注的一大需求。盡管我們的示例程序TodoList很簡單，但是我們也可以通過這個應(yīng)用程序，來實踐一下如何管理API接口版本。

目標(biāo)

實現(xiàn)API接口版本管理。

原理與思路

要實現(xiàn)API版本管理，我們需要這個庫：Microsoft.AspNetCore.Mvc.Versioning。它提供了.NET Web項目接口的版本管理功能。

實現(xiàn)

添加Nuget Package并配置服務(wù)

向Api項目中添加Microsoft.AspNetCore.Mvc.Versioning包。并添加一個擴(kuò)展方法：

ApiServiceExtensions.cs

using Microsoft.AspNetCore.Mvc;

namespace TodoList.Api.Extensions;

public static class ApiServiceExtensions
{
    public static void ConfigureApiVersioning(this IServiceCollection services)
    {
        services.AddApiVersioning(options =>
        {
            // 向響應(yīng)頭中添加API版本信息
            options.ReportApiVersions = true;
            // 如果客戶端不顯式指定API版本，則使用默認(rèn)版本
            options.AssumeDefaultVersionWhenUnspecified = true;
            // 配置默認(rèn)版本為1.0
            options.DefaultApiVersion = new ApiVersion(1, 0);
        });
    }
}

在Program中調(diào)用：

Program.cs

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

實現(xiàn)API版本控制

方法1: 添加ApiVersion屬性

我們復(fù)制一份TodoItemController到新文件TodoItemV2Controller并修改類名和構(gòu)造函數(shù)，其他保持原樣。為了給Controller標(biāo)記對應(yīng)的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版本相關(guān)字段

啟動Api項目，執(zhí)行查詢TodoItem的請求：

請求

-** 響應(yīng)**

日志輸出：

結(jié)果返回：

以及響應(yīng)頭信息中包含的api-supported-versions：

驗證2: 請求中添加查詢字符串api-version

啟動Api項目，執(zhí)行查詢TodoItem的請求：

請求

響應(yīng)

日志輸出：

結(jié)果返回（可以自己嘗試修改內(nèi)部邏輯，這里我懶了沒改實現(xiàn)，不過從日志已經(jīng)能看出請求確實進(jìn)入了V2版本的Controller）：

以及響應(yīng)頭信息中包含的api-supported-versions

方法2: 通過請求頭攜帶API版本信息

為了實現(xiàn)這一點，需要在ConfigureApiVersioning中增加配置：

ApiServiceExtensions.cs

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

驗證3: 通過請求頭攜帶API版本信息

啟動Api項目，執(zhí)行查詢TodoItem的請求：

請求

響應(yīng)日志輸出：

返回結(jié)果就不繼續(xù)貼了，以及響應(yīng)頭信息中包含的api-supported-versions

方法3: 通過URL路徑訪問對應(yīng)的版本

除了這種之外的以上幾種方法，都不需要修改接口的URI，而這種方式需要修改URI路徑。我們在兩個Controller上修改URI如下：

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

驗證4: 通過URI路徑選擇API版本

啟動Api項目，執(zhí)行查詢TodoItem的請求：

請求

響應(yīng)日志輸出：

返回結(jié)果就不繼續(xù)貼了，以及響應(yīng)頭信息中包含的api-supported-versions：

一點擴(kuò)展

有的時候我們需要標(biāo)記一個版本的請求為deprecated，但是還不想完全刪除這個Controller，可以用下面的方式進(jìn)行標(biāo)記，這樣返回頭中會指出這個版本的API已經(jīng)處于deprecated狀態(tài)了。

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

或者在ConfigureApiVersioning中使用Convention進(jìn)行標(biāo)記：

// 省略其他...
// 使用Convention標(biāo)記deprecated
options.Conventions.Controller<TodoItemV2Controller>().HasDeprecatedApiVersion(new ApiVersion(2, 0));

我們再請求2.0版本的API時，仍然可以獲取數(shù)據(jù)，但是得到的返回頭中信息如下：

對比使用Convention方式標(biāo)記的返回頭

總結(jié)

在本文中我們使用多種方式實現(xiàn)了管理API版本的需求，可以根據(jù)具體的需要選擇一種進(jìn)行實現(xiàn)。