时间:2021-05-28
前言
一般来说需要更改我们API的时候才考虑版本控制,但是我觉得我们不应该等到那时候来实现它,我们应该有一个版本策略从我们应用程序开发时就开始制定好我们的策略,我们一直遵循着这个策略进行开发。
我们其实可以通过多种方式进行实现我们API版本的控制,其实对于版本控制没有最好的方式,这完全取决于我们面向的使用者。
API版本控制类型
安装版本控制包
Install-Package Microsoft.AspNetCore.Mvc.Versioning在Startup.cs中的ConfigureServices方法中进行版本设置,以及在控制器通过特性进行设置版本,这样可以实现版本控制。
services.AddApiVersioning(options => { options.DefaultApiVersion = new ApiVersion(1, 0); options.AssumeDefaultVersionWhenUnspecified = true; options.ReportApiVersions = true;});默认提供了四种版本控制方法:
默认方法是使用名为api-version 的查询字符串参数。我们还可以自己定义一个版本控制规则。
API版本约束方式
字符串参数形式
HTTP请求头
组合方式
URL方式
我们可以更改代表版本的参数名称(例如,在上面的查询字符串方法中,我们使用字母v代替默认的api-version)。
控制器和方法中添加版本信息
选择版本控制策略并在ConfigureServices方法中对其配置后,我们可以开始对API端点进行版本控制,我们可以将这些属性应用于控制器和方法。
如果要使用URL路径则可以参考如下代码片段:
[Route("api/v{version:apiVersion}/[controller]")]API控制器弃用,我们只需要设置
[ApiVersion("1.0", Deprecated = true)]可通过如下方法方式获取所有API版本信息
var apiVersion = HttpContext.GetRequestedApiVersion();当然他还支持模型绑定,我们还可以通过模型形式获取
[HttpGet] public string Get(ApiVersion apiVersion) => $"Controller = {GetType().Name}\nVersion = {apiVersion}"; }API版本约束
我们除了在方法和控制器上指定我们的版本,我们还可以采用另一种方式
services.AddApiVersioning( options =>{ options.Conventions.Controller<HomeController>().HasApiVersion(1, 0);});看如上代码我们可以看到我们在这里给HomeController配置版本,这样方便我们集中管理我们的版本。
services.AddApiVersioning( options =>{ options.Conventions.Controller<MyController>() .HasDeprecatedApiVersion(1, 0) .HasApiVersion(1, 1) .HasApiVersion(2, 0) .Action(c => c.Get1_0()).MapToApiVersion(1, 0) .Action(c => c.Get1_1()).MapToApiVersion(1, 1) .Action(c => c.Get2_0()).MapToApiVersion(2, 0);});可以同时使用API版本约束和版本控制属性。
当然我们还可以自定义约束,从.NET Core 3.0开始,有一个IControllerConvention用于此目的的接口。
options.Conventions.Add(new MyCustomConvention());当然我们还可以通过不同命名空间中的接口进行约束
options.Conventions.Add(new VersionByNamespaceConvention());比如下面这种文件形式
api/v1/UsersController
api/v2/UsersController
api/v2_1/UsersController
映射后的路径如下所示
api/1.0/users
api/2.0/users
api/2.1/users
到此这篇关于ASP.NET Core3.x API版本控制的实现的文章就介绍到这了,更多相关ASP.NET Core3.x API版本控制内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持!
声明:本页内容来源网络,仅供用户参考;我单位不保证亦不表示资料全面及准确无误,也不保证亦不表示这些资料为最新信息,如因任何原因,本网内容或者用户因倚赖本网内容造成任何损失或损害,我单位将不会负任何法律责任。如涉及版权问题,请提交至online#300.cn邮箱联系删除。
在安装SQLServer2005时出现ASP.Net版本注册要求(警告),提示找不到ASP.Net在MicrosoftInternet信息服务(IIS)中的版本
asp.net操作access数据库是常见的数据库操作应用,本文就来实例讲解一下asp.net实现access数据库分页的方法。希望对大家的asp.net程序设
本文实例讲述了ASP.NET抓取网页内容的实现方法。分享给大家供大家参考。具体实现方法如下:一、ASP.NET使用HttpWebRequest抓取网页内容复制代
本文介绍一下ASP.Net中对XML的用法,这里飞刀我只是展现了XML与DataSet相结合的用法。其实ASP.Net对XML的操作的方法与对象是很多的,比如X
本文实例讲述了ASP.NET实现基于Forms认证的WebService应用方法。分享给大家供大家参考。具体实现方法如下:在安全性要求不是很高的ASP.Net程