无为清净楼资源网

ASP.NET Core3.x API版本控制的实现
网络编程 2024/11/16 佚名
3 2
无为清净楼资源网 Design By www.qnjia.com

前言

一般来说需要更改我们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;
});
  • options.DefaultApiVersion = new ApiVersion(1,0): 这个设置不是必须的，因为默认情况下给我们设置的是1.0，但是显式的声明出来是一个很好的习惯，当然DefaultApiVersion它会将默认的[ApiVersion("1.0")]添加到控制器上，也就是说它会隐式的绑定API版本，但是为了我们方便理解或者说方便我们后面开发建议显式的设置。
  • options.AssumeDefaultVersionWhenUnspecified = true:默认API版本控制需要将其属性设置为true才可以开启
  • options.ReportApiVersions = true:默认情况下它是禁用的，启用此选项后，来自我们API端点的响应将带有标头，告诉我们的客户端支持或不推荐使用哪个版本(api-supported-versions:1.1,2.0, api-deprecated-versions:1.0)

默认提供了四种版本控制方法：

  • 字符串参数
  • 通过HTTP请求头
  • URL方式
  • 媒体类型（Media Type）

默认方法是使用名为api-version 的查询字符串参数。我们还可以自己定义一个版本控制规则。

API版本约束方式

字符串参数形式

services.AddApiVersioning(options => 
  options.ApiVersionReader = new QueryStringApiVersionReader("v"));

HTTP请求头

services.AddApiVersioning(options => 
  options.ApiVersionReader = new HeaderApiVersionReader("api-version"));

组合方式

services.AddApiVersioning(options => {
  options.ApiVersionReader = ApiVersionReader.Combine(
    new QueryStringApiVersionReader("v"),
    new HeaderApiVersionReader("v"));});

URL方式

services.AddApiVersioning(options => options.ApiVersionReader = 
  new UrlSegmentApiVersionReader());

我们可以更改代表版本的参数名称（例如，在上面的查询字符串方法中，我们使用字母v代替默认的api-version）。

控制器和方法中添加版本信息

选择版本控制策略并在ConfigureServices方法中对其配置后，我们可以开始对API端点进行版本控制，我们可以将这些属性应用于控制器和方法。

  • 控制器的默认可能没有任何API版本属性，并隐式配置的默认API版本。默认配置使用值1.0。
  • 使用[ApiVersion("1.0")]属性注释我们的控制器，意味着该控制器支持API版本1.0
  • 控制器可以支持多个API版本。只需[ApiVersion(...)]在控制器上应用多个属性
  • 为了区分控制器支持的多个版本，我们使用[MapToApiVersion()]属性注释控制器方法。

如果要使用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
无为清净楼资源网 Design By www.qnjia.com
广告合作：本站广告合作请联系QQ：858582 申请时备注：广告合作（否则不回）
免责声明：本站文章均来自网站采集或用户投稿，网站不提供任何软件下载或自行开发的软件！ 如有用户或公司发现本站内容信息存在侵权行为，请邮件告知！ 858582#qq.com
无为清净楼资源网 Design By www.qnjia.com
www.qnjia.com 无为清净楼资源网
139,976互联网资源
144,792高清电影
21,817无损音乐
631,128技术资源
一句话新闻
苹果官宣WWDC 2024！预计会有大批AI功能 - 2024/11/16

3月27日消息，苹果宣布2024年全球开发者大会（WWDC）将于6月10日至6月14日举行，巧合的是，这次大会与端午假期重合。

苹果官方表示：

在线参加 Apple 每年规模最大的开发者盛会。亲眼见证 Apple 最新平台、技术和工具的发布。了解如何创建和改进你的 App 和游戏。与 Apple 设计师和工程师互动交流，与全球开发者社区建立联系。以上活动均免费在线举行。

探索各种新的工具、框架和功能，助力你打造出理想的 App 和游戏。通过视频讲座学习新技能，与 Apple 专家进行一对一会面，以推进你的项目，完善你的构思。

Swift Student Challenge 旨在支持和鼓舞下一代开发者、创作者和企业家。太平洋时间 3 月 28 日，我们将公布今年的获奖者名单。获奖者将有资格参加在 Apple Park 举办的特别活动。我们还会选出 50 名杰出获胜者，他们将受邀前往库比提诺，获得为期三天的非凡体验，包括参加 Apple Park 的特别活动。

RTX 5090要首发 性能要翻倍！三星展示GDDR7显存

三星在GTC上展示了专为下一代游戏GPU设计的GDDR7内存。

首次推出的GDDR7内存模块密度为16GB，每个模块容量为2GB。其速度预设为32 Gbps（PAM3），但也可以降至28 Gbps，以提高产量和初始阶段的整体性能和成本效益。

据三星表示，GDDR7内存的能效将提高20%，同时工作电压仅为1.1V，低于标准的1.2V。通过采用更新的封装材料和优化的电路设计，使得在高速运行时的发热量降低，GDDR7的热阻比GDDR6降低了70%。

更新日志

友情链接

杰晶网络 DDR爱好者之家 桃源资源网 杰网资源 富贵资源网 南强小屋 铁雪资源网 幽灵资源网 万梅资源网 狼山资源网 白云岛资源网 昆仑资源网 相思资源网 明霞山资源网 内蒙古资源网 黑松山资源网 茶园资源网 饿虎岗资源网 大旗谷资源网 常春岛资源网 岱庙资源网 兴国资源网 快活林资源网 蝙蝠岛资源网 帝王谷资源网 白云城资源网 伏龙阁资源网 清风细雨楼 天枫庄资源网 圆月山庄资源网 无争山庄资源网 神水资源网 移花宫资源网 神剑山庄资源网 无为清净楼资源网 金钱帮资源网 丐帮资源网 华山资源网 极乐门资源网 小李飞刀资源网 凤求凰客栈 风云阁资源网 金狮镖局 鸳鸯亭资源网 千金楼资源网 更多链接