ASP.NET Core中怎么实现版本控制

本篇文章给大家分享的是有关ASP.NET Core中怎么实现版本控制，小编觉得挺实用的，因此分享给大家学习，希望大家阅读完这篇文章后可以有所收获，话不多说，跟着小编一起来看看吧。

通过 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版本。在下面的示例中，我没有提到任何版本号，所以它在所有版本中使用最新版本。

以上就是ASP.NET Core中怎么实现版本控制，小编相信有部分知识点可能是我们日常工作会见到或用到的。希望你能通过这篇文章学到更多知识。更多详情敬请关注亿速云行业资讯频道。