ASP.NET Core中怎么實(shí)現(xiàn)版本控制

本篇文章給大家分享的是有關(guān)ASP.NET Core中怎么實(shí)現(xiàn)版本控制，小編覺(jué)得挺實(shí)用的，因此分享給大家學(xué)習(xí)，希望大家閱讀完這篇文章后可以有所收獲，話不多說(shuō)，跟著小編一起來(lái)看看吧。

通過(guò) NuGet 安裝此軟件包：Microsoft.AspNetCore.Mvc.Versioning。現(xiàn)在，在Startup.cs類的ConfigureServices()方法中配置服務(wù)(services.AddApiVersioning())：

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

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

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

接下來(lái)，您必須使用ApiVersion定義要支持 API 版本控制的控制器（多個(gè)版本）。同樣，您還必須使用MapToApiVersion定義特定Action API版本號(hào)：

[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" });
    }
}

現(xiàn)在通過(guò)GET方式的調(diào)用Action，您必須指定 API 版本，暫時(shí)使用查詢字符串版本控制方式。這樣，您將直接在查詢字符串中指定 API 版本。例如這個(gè)：http://localhost:5000/api/values?api-version=1.0。

如果您將 API 版本控制添加到現(xiàn)有的API項(xiàng)目中，則可以告知 ASP.NET Core 將默認(rèn)的控制器和Action視為版本1.0。為此，配置AddApiVersioning()服務(wù)如下所示：

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

現(xiàn)在可以像這樣 http://localhost:5000/api/values 調(diào)用API ，不會(huì)導(dǎo)致任何錯(cuò)誤。

可以通過(guò)三種方式指定API版本：

• 查詢字符 （已經(jīng)討論過(guò)）

• URL路徑

• 媒體類型（Media Type）

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

[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" });
    }
}

請(qǐng)注意，字母v不是強(qiáng)制要添加在版本號(hào)之前，這只是一個(gè)慣例。

最后，您可以將服務(wù)配置為從特定的媒體類型（默認(rèn)情況下，從content-type媒體類型讀取，您可以配置自己的媒體類型）讀取API版本號(hào)。如下所示，配置您的服務(wù)，以激活媒體類型版本控制：

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);
    });
}

現(xiàn)在，當(dāng)您發(fā)送HTTP請(qǐng)求時(shí)，在請(qǐng)求頭中content-type指定API版本號(hào)，如下所示（content-type: application/json;v=2.0）：

順便說(shuō)一句，使用CurrentImplementationApiVersionSelector，如果沒(méi)有在content-type媒體類型中定義版本，將使用最新的API版本。在下面的示例中，我沒(méi)有提到任何版本號(hào)，所以它在所有版本中使用最新版本。

以上就是ASP.NET Core中怎么實(shí)現(xiàn)版本控制，小編相信有部分知識(shí)點(diǎn)可能是我們?nèi)粘９ぷ鲿?huì)見(jiàn)到或用到的。希望你能通過(guò)這篇文章學(xué)到更多知識(shí)。更多詳情敬請(qǐng)關(guān)注億速云行業(yè)資訊頻道。