【轉】ASP.NET Core API 版本控制

標籤：ons   tps   更改   技術   www   接下來   版本   iat   oid   

幾天前，我和我的朋友們使用 ASP.NET Core 開發了一個API ，使用的是GET方式，將一些資料返回到用戶端 APP。我們在前端進行了分頁，意味著我們將所有資料發送給用戶端，然後進行一些data.length操作，以獲得items count用於分頁邏輯。為了減少HTTP請求的負荷，我們決定在後端（伺服器端分頁）實現邏輯。在我們這樣的情況下，這是沒有任何問題的，因為我們在用戶端能快速實現。我們在用戶端和服務端修改了所有邏輯，並且快速完成所有功能。

但是，您可能會有其他用戶端在使用，因為只提供了一個資料來源（API）。在一個API中引入突破性的變化可以支援一個用戶端，但同時破壞了其它用戶端。例如，假設您的手機團隊正在度假，並且您的 Web 團隊正在為了支援該伺服器端分頁功能開展工作。為了支援Web團隊，您在API中做了一個簡單的更改。這個變更，您和您的Web團隊都很高興（如果感到幸福你就拍拍手）。噩夢開始了，您會發現因為一個很簡單(其實是突破性)的變化，數百萬移動用戶端不工作，使用者會卸載APP。當您發現你們都不是行動裝置 App程式開發人員，也沒有訪問原始碼許可權時，更多的惡夢來了。現在您只能選擇降級您的 API 和 Web 應用程式，但是，Web 應用程式的Team Dev現在也去度假了。因為更多的惡夢會接踵而至，所有的事情都只能停滯不前。

也許（不是也許，就是！）API版本控制是在這種情況下，是一個非常不錯的選擇。使用 API 版本控制，您不僅可以安全地針對這些突破性的更改，還可以支援這些更改，這對每個人都是雙贏的。

我們來看一看如何在 ASP.NET Core 中配置 API 版本。

注意：我正在使用一個空的 ASP.NET Core Web API 項目（.NET Core 1.1）

通過 NuGet 安裝此軟體包：Microsoft.AspNetCore.Mvc.Versioning。現在，在Startup.cs類的ConfigureServices()方法中佈建服務(services.AddApiVersioning())：

public void ConfigureServices(IServiceCollection services){    services.AddMvc();    services.AddApiVersioning();}

當您使用的是Microsoft.AspNetCore.Mvc.Versioning 的1.1.1版本時，只需要使用app.UseApiVersioning()方法：

public void Configure(IApplicationBuilder app, IHostingEnvironment env,                       ILoggerFactory loggerFactory){    /* garbage code removed */    app.UseMvc();    app.UseApiVersioning();}

接下來，您必須使用ApiVersion定義要支援 API 版本控制的控制器（多個版本）。同樣，您還必須使用MapToApiVersion定義特定Action API版本號碼：

[ApiVersion("2.0")][Route("api/[controller]")]public class ValuesController : Controller{    // GET api/values    [MapToApiVersion("1.0")]    [HttpGet]    public IEnumerable<string> Get()    {        return Json(new string[] { "value1", "value2" });    }}

現在通過GET方式的調用Action，您必須指定 API 版本，暫時使用查詢字串版本控制方式。這樣，您將直接在查詢字串中指定 API 版本。例如這個：http://localhost:5000/api/values?api-version=1.0。

如果您將 API 版本控制添加到現有的API項目中，則可以告知 ASP.NET Core 將預設的控制器和Action視為版本1.0。為此，配置AddApiVersioning()服務如下所示：

services.AddApiVersioning(options => options.AssumeDefaultVersionWhenUnspecified = true);

現在可以像這樣 http://localhost:5000/api/values 調用API ，不會導致任何錯誤。

可以通過三種方式指定API版本：

• 查詢字元 （已經討論過）
• URL路徑
• 媒體類型（Media Type）

通過URL路徑的方式，您可以將版本號碼作為URL路徑的一部分傳遞。像這樣的例子 http://localhost:5000/api/v1/values 。順便說一句，您必須修改您的路由屬性以適應版本段，如下所示：

[ApiVersion("1.0")][Route("api/v{version:apiVersion}/[controller]")]public class ValuesController : Controller{    [HttpGet, MapToApiVersion("1.0")]    public IActionResult Get()    {        return Json(new string[] { "value1", "value2" });    }}

請注意，字母v不是強制要添加在版本號碼之前，這隻是一個慣例。

最後，您可以將服務配置為從特定的媒體類型（預設情況下，從content-type媒體類型讀取，您可以配置自己的媒體類型）讀取API版本號碼。如下所示，配置您的服務，以啟用媒體類型版本控制：

public void ConfigureServices(IServiceCollection services){        // Add framework services.    services.AddMvc();    services.AddApiVersioning(options =>    {        options.ApiVersionReader = new MediaTypeApiVersionReader();        options.AssumeDefaultVersionWhenUnspecified = true;        options.ApiVersionSelector = new CurrentImplementationApiVersionSelector(options);    });}

現在，當您發送HTTP請求時，在要求標頭中content-type指定API版本號碼，如下所示（content-type: application/json;v=2.0）：

順便說一句，使用CurrentImplementationApiVersionSelector，如果沒有在content-type媒體類型中定義版本，將使用最新的API版本。在下面的樣本中，我沒有提到任何版本號碼，所以它在所有版本中使用最新版本。

這不是全部的功能，還有其它很酷的功能，您可以在 Microsoft 的 Microsoft‘s ASP.NET API Versioning git存放庫中找到這些功能：https://github.com/Microsoft/aspnet-api-versioning/wiki。

發現一篇同類型的文章，講解的更詳細，供大家參考：http://www.talkingdotnet.com/support-multiple-versions-of-asp-net-core-web-api/。

原文地址： https://www.codeproject.com/Tips/1197505/ASP-NET-Core-API-Versioning-in-Simple-Words-Update
翻譯：Sweet Tang
本文地址：http://www.cnblogs.com/tdfblog/p/asp-net-core-api-versioning.html
歡迎轉載，請在明顯位置給出出處及連結。

 

【轉】ASP.NET Core API 版本控制