ASP.Net Core中關於WebApi幾種版本控制對比詳解（圖）

這篇文章主要介紹了淺談ASP.Net Core WebApi幾種版本控制對比,小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟著小編過來看看吧

一、版本控制的好處：

（1）有助於及時推出功能, 而不會破壞現有系統。

（2）它還可以幫助為選定的客戶提供額外的功能。

API 版本控制可以採用不同的方式進行控制，方法如下：

（1）在URL 中追加版本或作為查詢字串參數,

#（2）透過自訂標頭和透過接受標頭

在這篇文章中, 讓我們來看看如何支援多個版本的ASP.NET Core Web API。

一、建立asp.net core webapi 項目，引用NuGet套件：Install-Package Microsoft.AspNetCore.Mvc.Versioning -Version 2.0.0

專案和安裝套件都好了，接著我們需要在Startup.cs中的ConfigureServices 方法中加入下面的程式碼：

如您所見, 配置了3不同的選項。

• ReportAPIVersions: 這是可選的。但是, 當設定為 true 時, API 將傳回回應標頭中支援的版本資訊。

• AssumeDefaultVersionWhenUnspecified: 此選項將用於不提供版本的請求。預設, 假定的 API 版本為1.0。

• DefaultApiVersion: 此選項用於指定在請求中未指定版本時要使用的預設 API 版本。這將預設版本為1.0。

這是所有的配置和設定。現在, 我們將看到存取 API 版本的不同方式。

二、透過QueryString來實作版本控制

開啟我們的控制器，在上面加入ApiVersion特性，如下程式碼所示：

#上面的程式碼作為1.0版本。您也可以在不同的命名空間中建立另一個具有相同名稱的控制器類別, 並將 API 版本設定為2.0版本。如下圖所示：

就這樣。現在轉到瀏覽器並存取控制器。您應該會看到 API 版本1.0 控制器的輸出, 因為它被設定為預設值。現在在 URL 中追加 api-version=2, 您應該會看到 api 版本2.0 控制器的輸出。

查詢字串參數很有用, 但在長URL 和其他查詢字串參數的情況下可能會很痛苦。相反, 更好的方法是在 URL 路徑中添加版本。例如：

api/v1/values

#api/v2/values

##還是上面的項目，只不過需要在v1和v2控制器中加入，下面的程式碼。如下圖所示：

#####################相同, 您需要將路由參數更新到所有適用的位置。使用此變更, 在存取API 介面時總是需要有版本號。您可以透過 api/v1/values 存取到版本 1.0, 透過api/v2/values存取版本 2.0, 變更 URL 中的版本號。簡單, 看起來更乾淨了。 ######測試結果如下：###############################三、透過HTTP Headers實現版本控制# ###########在上述兩種方法中, 需要修改URL 以支援版本控制。但是, 如果您希望 api 的URL 保持乾淨, 則 api 版本資訊也可以透過附加 HTTP 標頭來傳遞。要進行此工作, 您需要配置 ApiVersionReader 選項。程式碼如下：###

突出顯示的行告訴我們header "api-version" 現在是 api 版本號碼的預期位置。確保路由屬性沒有版本詳細資訊。所以測試它，結果如下：

當您將2.0 作為值提供給 "api 版本" 時, 它將調用版本2.0 控制器並傳回輸出。

簡單, 易於設定。但是, 現在查詢字串參數的方法進行版本控制將不起作用。一旦設定了header, 就不能指定查詢字串參數。如果您希望支援這兩種情況, 而不是 HeaderApiVersionReader, 請使用 QueryStringOrHeaderApiVersionReader。程式碼如下：

因此, 現在支援查詢字串參數和header。預設查詢字串參數名稱是 api-version, 因此您可以將建構函式留空, 但如果需要其他名稱, 則需要提供。您也可以對查詢字串參數和標頭使用有不同的名稱。請記住, 我們也將 ReportApiVersions 設為 true, 該值回傳回應標頭中的版本資訊。見下圖。

現在, 讓我們來看看另外幾個選項。

MapToApiVersion參數的用法：

MapToApiVersion 屬性允許將單一 API 操作對應到任何版本。換言之, 一個支援多個版本的單控制器。控制器可能只有版本3支援的 API 操作方法。在這種情況下, 您可以使用 MapToApiVersion。看看下面的程式碼。

上面程式碼的意思是：public string Get()該方法只有在版本1.0中支持，public string Getv3()方法只有在版本3.0中支援。

有圖片有真像，很靈活，我很喜歡。

Deprecated參數的用法：

當支援多個 API 版本時, 某些版本最終會隨著時間的推移而被棄用。要標記一個或多個 api 版本已被廢棄, 只需用Deprecated修飾您的控制器。這並不意味著不支援 API 版本。你仍然可以呼叫該版本。它只是一種讓 呼叫API 用戶意識到以下版本在將來會被棄用。

上面把Deprecated設定為TRUE表示，版本1.0將來會被棄用。存取我們的API接口，可以在回應頭中可以看到，下面訊息，如下圖所示：

ApiVersionNeutral特性的使用：

ApiVersionNeutral特性定義此API 不在支援版本控制。無論 支援api 版本控製或不支援 api 版本控制的舊式 api，這對於行為完全相同的 api 非常有用。因此, 您可以新增 ApiVersionNeutral 屬性以從版本控制中退出。

取得版本資訊（Version Information）

如果你想知道那個版本的客戶端正在被訪問，你可以透過下面的程式碼實現該功能：

綜上所述, 具有多個版本的API 可以幫助以一種有效的方式推出增強的功能, 同時也便於跟踪更改。在這篇文章中, 我們看到瞭如何在 ASP.NET coreWEB API 中新增對多個版本的支援。 nuget 套件支援透過查詢字串參數進行版本控制, 在 URL 中新增路徑段和透過標頭。它還具有版本單一 API 操作和從版本中選擇退出的功能。

能不能不借助第三方的套件來實現一個API的版本控制，方法是有的，不賣關子了，大家接著往下看。

四、終極版本（不使用任何NuGet套件）asp.net core web api版本控制

新建一個core API專案：

在VersionControl資料夾下面，新建一個實作了IApplicationModelConvention介面的類別NameSpaceVersionRoutingConvention程式碼如下：

#

public class NameSpaceVersionRoutingConvention:IApplicationModelConvention
  {
    private readonly string apiPrefix;
    private const string urlTemplate = "{0}/{1}/{2}";
    public NameSpaceVersionRoutingConvention(string apiPrefix = "api")
    {
      this.apiPrefix = apiPrefix;
    }

    public void Apply(ApplicationModel application)
    {
      foreach (var controller in application.Controllers)
      {
        
        var hasRouteAttribute = controller.Selectors
        .Any(x => x.AttributeRouteModel != null);
        if (!hasRouteAttribute)
        {
          continue;
        }
        var nameSpaces = controller.ControllerType.Namespace.Split('.');
        //获取namespace中版本号部分
        var version = nameSpaces.FirstOrDefault(x => Regex.IsMatch(x, @"^v(\d+)$"));
        if (string.IsNullOrEmpty(version))
        {
          continue;
        }
        string template = string.Format(urlTemplate, apiPrefix, version,
        controller.ControllerName);
        controller.Selectors[0].AttributeRouteModel = new AttributeRouteModel()
        {
          Template = template
        };
      }
    }
  }

#偵錯程式碼發現這種方式只在程式第一次運作的時候會執行，之後不會再執行多次，因此效率很高。

五、總結：

#

以上是ASP.Net Core中關於WebApi幾種版本控制對比詳解（圖）的詳細內容。更多資訊請關注PHP中文網其他相關文章！