ASP.Net Core WebApi几种版本控制对比

一、版本控制的好处:

(1)有助于及时推出功能, 而不会破坏现有系统。

(2)它还可以帮助为选定的客户提供额外的功能。

API 版本控制可以采用不同的方式进行控制,方法如下:

(1) URL 中追加版本或作为查询字符串参数,

(2)通过自定义标头和通过接受标头

在这篇文章中, 让我们来看看如何支持多个版本的 ASP.NET  Core  Web API。

一、创建asp.net core webapi 项目,引用NuGet包:Install-Package Microsoft.AspNetCore.Mvc.Versioning -Version 2.0.0

 

 

项目和安装包都好了,接着我们需要在Startup.cs中的ConfigureServices 方法中添加下面的代码:

 

 

如您所见配置了3不同的选项。

  •  ReportAPIVersions: 这是可选的。但是当设置为 true , API 将返回响应标头中支持的版本信息。

  •  AssumeDefaultVersionWhenUnspecified: 此选项将用于不提供版本的请求。默认情况下假定的 API 版本为1.0

  • DefaultApiVersion: 此选项用于指定在请求中未指定版本时要使用的默认 API 版本。这将默认版本为1.0

这是所有的配置和设置。现在我们将看到访问 API 版本的不同方式。

 

二、通过QueryString来实现版本控制

打开我们的控制器,在上面添加ApiVersion特性,如下代码所示:

上面的代码作为1.0版本。您还可以在不同的命名空间中创建另一个具有相同名称的控制器类并将 API 版本设置为2.0版本。如下图所示:

 

就这样。现在转到浏览器并访问控制器。您应该看到 API 版本1.0 控制器的输出因为它被设置为默认值。现在在 URL 中追加 api-version=2, 您应该看到 api 版本2.0 控制器的输出。

二、通过URL Path Segment来实现:

查询字符串参数很有用但在长 URL 和其他查询字符串参数的情况下可能会很痛苦。相反更好的方法是在 URL 路径中添加版本。比如:

  • api/v1/values

  • api/v2/values

还是上面的项目,只不过需要在v1v2控制器中加入,下面的代码。如下图所示:

同样您需要将路由参数更新到所有适用的位置。使用此更改在访问API 接口时总是需要有版本号。您可以通过 api/v1/values 访问到版本 1.0, 通过api/v2/values 访问版本 2.0, 更改 URL 中的版本号。简单看起来更干净了。

测试结果如下:

三、通过HTTP Headers来实现版本控制

在上述两种方法中需要修改 URL 以支持版本控制。但是如果您希望 api URL 保持干净则 api 版本信息也可以通过附加 HTTP 报头来传递。要进行此工作您需要配置 ApiVersionReader 选项。代码如下:

 

 

 

突出显示的行告诉我们header  "api-version" 现在是 api 版本号的预期位置。确保路由属性没有版本详细信息。所以测试它,结果如下:

当您将2.0 作为值提供给 "api 版本它将调用版本2.0 控制器并返回输出。

简单易于设置。但是现在查询字符串参数的方法进行版本控制将不起作用。一旦设置了header, 就不能指定查询字符串参数。如果您希望支持这两种情况而不是 HeaderApiVersionReader, 请使用 QueryStringOrHeaderApiVersionReader。代码如下:

 

因此现在支持查询字符串参数和header。默认查询字符串参数名称是 api-version, 因此您可以将构造函数留空但如果需要其他名称则需要提供。您还可以对查询字符串参数和标头使用有不同的名称。请记住我们还将 ReportApiVersions 设置为 true, 该值返回响应标头中的版本信息。见下图。

 

现在, 让我们来看看另外几个选项。

MapToApiVersion参数的用法:

MapToApiVersion 属性允许将单个 API 操作映射到任何版本。换言之一个支持多个版本的单控制器。控制器可能只有版本3支持的 API 操作方法。在这种情况下您可以使用 MapToApiVersion。看看下面的代码。

上面代码的意思是:public string Get()该方法只有在版本1.0中支持,public string Getv3()方法只有在版本3.0中支持。

有图有真像,很灵活,我很喜欢。

Deprecated参数的用法:

当支持多个 API 版本时某些版本最终会随着时间的推移而被弃用。要标记一个或多个 api 版本已被废弃, 只需用Deprecated修饰您的控制器。这并不意味着不支持 API 版本。你仍然可以调用版本。它只是一种让 调用API 用户意识到以下版本在将来会被弃用。

上面把Deprecated设置为TRUE表示,版本1.0将来会被弃用。访问我们的API接口,可以在响应头中可以看到,下面信息,如下图所示:

ApiVersionNeutral特性的使用:

ApiVersionNeutral 特性定义此 API 不在支持版本控制。无论 支持api 版本控制或不支持 api 版本控制的旧式 api这对于行为完全相同的 api 非常有用因此您可以添加 ApiVersionNeutral 属性以从版本控制中退出。

获取版本信息(Version Information)

如果你想知道那个版本的客户端在被访问,你可以通过下面的代码实现该功能:

综上所述具有多个版本的 API 可以帮助以一种有效的方式推出增强的功能同时也便于跟踪更改。在这篇文章中我们看到了如何在 ASP.NET  core WEB API 中添加对多个版本的支持。nuget 包支持通过查询字符串参数进行版本控制在 URL 中添加路径段和通过标头。它还具有版本单一 API 操作和从版本中选择退出的功能

能不能不借助第三方的包来实现一个API的版本控制,方法是有的,不卖关子了,大家接着往下看。

 

四、终极版本(不借助任何NuGet)asp.net core web api版本控制

新建一个core API项目:

 

在VersionControl文件夹下面,新建一个实现了IApplicationModelConvention接口的类NameSpaceVersionRoutingConvention   代码如下:

 

public class NameSpaceVersionRoutingConvention:IApplicationModelConvention

    {

        private readonly string apiPrefix;

        private const string urlTemplate = "{0}/{1}/{2}";

        public NameSpaceVersionRoutingConvention(string apiPrefix = "api")

        {

            this.apiPrefix = apiPrefix;

        }


        public void Apply(ApplicationModel application)

        {

            foreach (var controller in application.Controllers)

            {

                

                var hasRouteAttribute = controller.Selectors

                .Any(x => x.AttributeRouteModel != null);

                if (!hasRouteAttribute)

                {

                    continue;

                }

                var nameSpaces = controller.ControllerType.Namespace.Split('.');

                //获取namespace中版本号部分

                var version = nameSpaces.FirstOrDefault(x => Regex.IsMatch(x, @"^v(\d+)$"));

                if (string.IsNullOrEmpty(version))

                {

                    continue;

                }

                string template = string.Format(urlTemplate, apiPrefix, version,

                controller.ControllerName);

                controller.Selectors[0].AttributeRouteModel = new AttributeRouteModel()

                {

                    Template = template

                };

            }

        }

    }

调试代码发现这种方式只在程序第一次运行的时候会执行,之后不会再执行多次,因此效率很高。

五、总结:

通过上面两种版本控制的实现和对比,我更偏向通过第三方的包来实现版本控制,这种方法功能更强大。这纯属于个人爱好了,大家可以根据不同的场景来决定使用哪种方式来实现,好了讲到这里,谢谢,希望对你有帮助。

觉得可以的话,希望点下推荐哈~你们的推荐是我的动力。

原文地址:http://www.cnblogs.com/runningsmallguo/p/7484954.html


.NET社区新闻,深度好文,微信中搜索dotNET跨平台或扫描二维码关注

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/323744.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

POJ2279-Mr. Young's Picture Permutations【线性dp】

正题 题目链接:http://poj.org/problem?id2279 题目大意 有k列,每列人数不同,要求从左到右和从前到后身高都单调递减,学生高度是1∼N1∼N(人数总和) 解题思路 我们开一个五维数组,然后每次在人少那列填充,按照这总…

JoyOI(TYVJ)1071-LCIS【线性dp,LIS,LCS】

正题 题目链接:http://www.joyoi.cn/problem/tyvj-1071 题目大意 求两个序列的最长公共上升子序列。 code 我们先回顾一下LIS和LCS LIS:fimax{fj1}(j<i,aj<ai)fimax{fj1}(j<i,aj<ai)LCS:fi,jmax⎧⎩⎨⎪⎪⎪⎪⎪⎪⎪⎪⎪⎪⎪⎪⎪⎪fi−1,jfi,j−1fi−1,j−11(a…

asp.net core策略授权

在《asp.net core认证与授权》中讲解了固定和自定义角色授权系统权限&#xff0c;其实我们还可以通过其他方式来授权&#xff0c;比如可以通过角色组&#xff0c;用户名&#xff0c;生日等&#xff0c;但这些主要取决于ClaimTypes&#xff0c;其实我们也可以自定义键值来授权&a…

Safari浏览器不支持let声明的解决方式

大家好&#xff0c;我是雄雄&#xff0c;欢迎关注微信公众号&#xff1a;雄雄的小课堂 前言 现在是2022年1月7日16:19:38,前几天用publiccms改了个网站&#xff0c;因为客户那边各种机型都有&#xff08;各PC端的分辨率也都不一样&#xff09;&#xff0c;所以导致页面呈现的效…

Executor 与 ExecutorService 和 Executors 傻傻分不清

转载自 Executor 与 ExecutorService 和 Executors 傻傻分不清 java.util.concurrent.Executor, java.util.concurrent.ExecutorService, java.util.concurrent. Executors 这三者均是 Java Executor 框架的一部分&#xff0c;用来提供线程池的功能。因为创建和管理线程非常心…

POJ3666-Making the Grade【线性dp】

正题 题目链接&#xff1a;http://poj.org/problem?id3666 题目大意 给定序列A,B。要求B严格单调&#xff0c;要求最小化 S∑Ni1|Ai−Bi|S∑Ni1|Ai−Bi|解题思路 根据书上说的数学归纳法&#xff0c;我们可以证明在S最小化的条件下&#xff0c;一定存在一种构造B的方案&am…

ASP.NET Core 2.0 自定义 _ViewStart 和 _ViewImports 的目录位置

在 ASP.NET Core 里扩展 Razor 查找视图目录不是什么新鲜和困难的事情&#xff0c;但 _ViewStart 和 _ViewImports 这2个视图比较特殊&#xff0c;如果想让 Razor 在我们指定的目录中查找它们&#xff0c;则需要耗费一点额外的精力。本文将提供一种方法做到这一点。注意&#x…

Safari浏览器不支持……

大家好&#xff0c;我是雄雄&#xff0c;欢迎关注微信公众号&#xff1a;雄雄的小课堂前言现在是2022年1月7日16:19:38,前几天用publiccms改了个网站&#xff0c;因为客户那边各种机型都有&#xff08;各PC端的分辨率也都不一样&#xff09;&#xff0c;所以导致页面呈现的效果…

json-lib的字符串自动转换坑

一、场景复现 &#xff08;1&#xff09;代码 import com.google.gson.Gson; import com.google.gson.GsonBuilder; import com.google.gson.JsonObject; import com.google.gson.JsonParser; import net.sf.json.JSONObject;public class C {public static void main(String…

JoyOI(TYVJ)1061-Mobile Service【线性dp】

正题 题目链接:http://www.joyoi.cn/problem/tyvj-1061 题目大意 有n个点&#xff0c;每个点之间都有权值不同的边&#xff0c;有3个机器人&#xff0c;有m个任务地点&#xff0c;机器人必须按顺序赶到任务地点&#xff0c;求最小代价。 解题思路 我们可以让fi,jfi,j表示两个…

开源分享 Unity3d客户端与C#分布式服务端游戏框架

很久之前&#xff0c;在博客园写了一篇文章&#xff0c;《分布式网游server的一些想法语言和平台的选择》&#xff0c;当时就有了用C#做网游服务端的想法。写了个Unity3d客户端分布式服务端框架&#xff0c;最近发布了1.0版本&#xff0c;取名ET框架。ET框架的目标就是简化客户…

freemarker中遇到null报错的处理方法

错误分析 今天遇到了这样的个问题&#xff0c;就是在获取分类的父id的时候发现如果是父级分类&#xff0c;则回去父id就会报错。 直接导致了后面的样式失败。 解决办法&#xff1a; 给添加了个默认值0&#xff0c;就可以了&#xff0c;代码如下&#xff1a; var cate_pare…

IDEA的debug方法头坑

一、现象复现 web程序跑起来很卡顿&#xff0c;十几分钟都跑步起来&#xff0c;而且页面刷新十几秒都没有反应。 三月 23, 2019 11:58:22 上午 com.mchange.v2.log.MLog <clinit> 信息: MLog clients using java 1.4 standard logging. 三月 23, 2019 11:58:22 上午 co…

背包例题の01,完全,多重

01背包&#xff1a;TYVJ1096-数字组合 题目链接:http://www.joyoi.cn/problem/tyvj-1096 题目大意 给N个正整数&#xff0c;求能组成M的方法有多少种 解题思路 不是说了吗&#xff0c;01背包呀&#xff01; code #include<cstdio> using namespace std; int n,m,a[10…

ASP.NET Core MVC I\/O编程模型

1.1. I/O编程模型浅析 服务器端编程经常需要构造高性能的IO模型&#xff0c;常见的IO模型有四种&#xff1a; &#xff08;1&#xff09;同步阻塞IO&#xff08;Blocking IO&#xff09;&#xff1a;即传统的IO模型。 &#xff08;2&#xff09;同步非阻塞IO&#xff08;Non…

几天没写代码,就……

“大家好&#xff0c;我是雄雄&#xff0c;欢迎关注微信公众号&#xff1a;雄雄的小课堂”前言现在是2022年2月1日21:07:37&#xff0c;今天是农历2022年的第一天&#xff0c;祝大家虎年大吉&#xff0c;新的一年里身体健康&#xff0c;事业有成&#xff01;&#xff01;&#…

深入浅出 Java CMS 学习笔记

转载自 深入浅出 Java CMS 学习笔记 引子 带着问题去学习一个东西&#xff0c;才会有目标感&#xff0c;我先把一直以来自己对CMS的一些疑惑罗列了下&#xff0c;希望这篇学习笔记能解决掉这些疑惑&#xff0c;希望也能对你有所帮助。 1、 CMS出现的初衷、背景和目的&#x…

P1352-没有上司的舞会【树形dp】

正题 评测记录:https://www.luogu.org/recordnew/lists?uid52918&pidP1352 题目大意 一棵树&#xff0c;如果选择了子节点那么就不能选择父节点&#xff0c;如果选择了父节点那么就不能选择子节点。 求选择的点的最大权值和。 解题思路 和最大利润类似。 code #inclu…

vue利用级联选择器实现全国省市区乡村五级菜单联动

“大家好&#xff0c;我是雄雄&#xff0c;欢迎关注微信公众号&#xff1a;雄雄的小课堂。”现在是&#xff1a;2022年2月13日20:09:27今天分享一个五级级联地址的组件的使用吧。前言接到这样的一个需求&#xff1a;需要根据地址查询列表信息&#xff0c;地址可以分别按照省、市…

业务库负载翻了百倍,我做了什么来拯救MySQL架构

转载自 业务库负载翻了百倍&#xff0c;我做了什么来拯救MySQL架构 作者介绍 杨建荣&#xff0c;竞技世界资深DBA&#xff0c;前搜狐畅游数据库专家&#xff0c;Oracle ACE&#xff0c;YEP成员。拥有近十年数据库开发和运维经验&#xff0c;目前专注于开源技术、运维自动化和…