Api的版本控制是Api開發中經常遇到的問題, 在大部分中大型項目都需要使用到Api的版本控制,這篇文章主要介紹了.Net Core Api 使用版本控制詳解,感興趣的小夥伴們可以參考一下
Api的版本控制是Api開發中經常遇到的問題, 在大部分中大型項目都需要使用到Api的版本控制
在本篇博客中,我們將說明一下如何在.Net Core Api項目中使用Api版本控制。
本篇博客中測試項目的開發環境:
- Visual Studio 2017
- .Net Core 2.1 SDK
1,安裝Microsoft.AspNetCore.Mvc.Versioning
NET Core Mvc中,微軟官方提供了一個可用的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
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持神馬文庫。