一、版本控制的好处:
(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
还是上面的项目,只不过需要在v1和v2控制器中加入,下面的代码。如下图所示:
同样, 您需要将路由参数更新到所有适用的位置。使用此更改, 在访问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。代码如下: