.Net Core Api 使用版本控制詳解

更新時(shí)間：2018年10月08日 11:10:28 作者：Akgu

Api的版本控制是Api開發(fā)中經(jīng)常遇到的問題, 在大部分中大型項(xiàng)目都需要使用到Api的版本控制，這篇文章主要介紹了.Net Core Api 使用版本控制詳解，感興趣的小伙伴們可以參考一下

Api的版本控制是Api開發(fā)中經(jīng)常遇到的問題, 在大部分中大型項(xiàng)目都需要使用到Api的版本控制

在本篇博客中，我們將說明一下如何在.Net Core Api項(xiàng)目中使用Api版本控制。

本篇博客中測(cè)試項(xiàng)目的開發(fā)環(huán)境：

Visual Studio 2017
.Net Core 2.1 SDK

1，安裝Microsoft.AspNetCore.Mvc.Versioning

NET Core Mvc中，微軟官方提供了一個(gè)可用的Api版本控制庫(kù)Microsoft.AspNetCore.Mvc.Versioning。

2，修改Startup類

這里我們需要在Startup類的ConfigureService方法中添加以下代碼。

// This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
      services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
      services.AddApiVersioning(o =>
      {
        o.ReportApiVersions = true;
        o.AssumeDefaultVersionWhenUnspecified = true;
        o.DefaultApiVersion = new ApiVersion(1, 0);
        //o.ApiVersionReader = new HeaderApiVersionReader("x-api-version");
      });
    }

3，代碼

//版本1控制器
  [ApiVersion("1.0", Deprecated = true)]
  [Route("api/values")]
  [ApiController]
  public class ValuesV1Controller : ControllerBase
  {
    [HttpGet]
    public IEnumerable<string> Get()
    {
      return new string[] { "這是版本1.0返回的——數(shù)據(jù)1", "這是版本1.0返回的——數(shù)據(jù)2" };
    }
  }

//版本2控制器
  [ApiVersion("2.0")]
  [Route("api/values")]
  [ApiController]
  public class ValuesV2Controller : ControllerBase
  {
    [HttpGet]
    public IEnumerable<string> Get()
    {
      return new string[] { "這是版本2.0返回的——數(shù)據(jù)1", "這是版本2.0返回的——數(shù)據(jù)2" };
    }
  }

4，訪問

https://localhost:44319/api/values