.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
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。
相关文章
.Net Core中使用ExceptionFilter过滤器的方法
这篇文章主要介绍了.Net Core中使用ExceptionFilter过滤器的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2020-03-03使用Visual Studio 2017作为Linux C++开发工具
这篇文章主要为大家详细介绍了使用Visual Studio 2017作为Linux C++开发工具的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下2017-03-03.net面向对象之多线程(Multithreading)及 多线程高级应用
这篇文章主要介绍.net面向对象程序设计阶段多线程Multithreading及多线程高级应用的介绍,需要的朋友可以参考下2015-07-07asp.net中获取远程网页的内容之一(downmoon原创)
asp.net中获取远程网页的内容之一(downmoon原创)...2007-04-04
最新评论