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

 更新时间£º2018年10月08日 11:10:28   作者£ºAkgu   我要评论

Api的版本控制是Api开发中经常遇到的问题, 在大部分中大型项目都需要使用到Api的版本控制£¬这篇文章主要介绍了.Net Core Api 使用版本控制详解£¬感兴趣的小伙伴们可以参?#23478;?#19979;

Api的版本控制是Api开发中经常遇到的问题, 在大部分中大型项目都需要使用到Api的版本控制

在本篇博客中£¬我们将说明一下如何在.Net Core Api项目中使用Api版本控制¡£

本篇博客中测试项目的开发环?#24120;?/p>

  • Visual Studio 2017
  • .Net Core 2.1 SDK

1£¬安装Microsoft.AspNetCore.Mvc.Versioning

NET Core Mvc中£¬微软官?#25945;?#20379;了一个可用的Api版本控制库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返回的¡ª¡ª数据1", "这是版本1.0返回的¡ª¡ª数据2" };
    }
  }
//版本2控制器
  [ApiVersion("2.0")]
  [Route("api/values")]
  [ApiController]
  public class ValuesV2Controller : ControllerBase
  {
    [HttpGet]
    public IEnumerable<string> Get()
    {
      return new string[] { "这是版本2.0返回的¡ª¡ª数据1", "这是版本2.0返回的¡ª¡ª数据2" };
    }
  }

4£¬访问

https://localhost:44319/api/values

https://localhost:44319/api/values?api-version=1.0

https://localhost:44319/api/values?api-version=2.0

以上就是本文的全部内容£¬希望对大家的学习?#20852;?#24110;助£¬也希望大家多多支持脚本之家¡£

相关文章

最新评论

ÁÉÄþ35Ñ¡7¿ª½±½á¹û