asp.net 带有版本控制的 API 接口实现 Microsoft.AspNetCore.Mvc.Versioning

最新推荐文章于 2024-11-04 15:07:55 发布

大新软件技术部

最新推荐文章于 2024-11-04 15:07:55 发布

阅读量741

点赞数

CC 4.0 BY-SA版权

分类专栏： ASP.NET CORE

本文链接：https://blog.youkuaiyun.com/yangyifan0/article/details/115047730

ASP.NET CORE 专栏收录该内容

2 篇文章

订阅专栏

本文介绍如何使用Microsoft.AspNetCore.Mvc.Versioning包实现API版本控制。通过配置默认版本和未指定版本时的行为，结合Swagger测试工具验证API版本的有效性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

使用 Versioning 之前，需要在我们的 API 项目中添加对于该 dll 的引用。这里需要注意下安装的版本问题，因为 Grapefruit.VuCore 这个框架距离现在搭建也有几个月的时间了，在这个月初的时候 .NET Core 2.2 也已经发布了，如果你和我一样还是采用的 .NET Core 2.1 版本的话，这里安装的 Versioning 版本最高只能到 2.3。

Install-Package Microsoft.AspNetCore.Mvc.Versioning

　　当我们安装完成之后，就可以进行配置了。

public void ConfigureServices(IServiceCollection services)
        {
            //.....

            services.AddApiVersioning(o =>
            {
                o.ReportApiVersions = true;//这个配置是可选的，当我们设置为 true 时，API 会在响应的 header 中返回版本信息
                o.DefaultApiVersion = new ApiVersion(1, 0);//　　DefaultApiVersion：指定在请求中未指明版本时要使用的默认 API 版本。这将默认版本为1.0。
                o.AssumeDefaultVersionWhenUnspecified = true;//这个配置项将用于在没有指明 API 版本的情况下提供请求，默认情况下，会请求默认版本的 API，例如，这里就会请求 1.0 版本的 API。
            });
        }

在 Controllers 文件夹下新增一个 v1 文件夹，将所有 v1 版本的 Controller 都建在这个目录下。新建一个 Controller，添加上 ApiVersion Attribute 指明当前的版本信息。因为我采用的方案是在 Url 中指明 API 版本，所以，我们还需要在 Route 中修改我们的路由属性以对应 API 的版本。这里的 v 只是一个默认的惯例，你也可以不添加。

[ApiVersion("1.0")]
[Route("api/v{version:apiVersion}/[controller]")]
[ApiController]
public class VaulesController : ControllerBase
{
}

　　当我们修改好我们的 Controller 之后，运行我们的项目，你会发现，API 文档中显示的请求地址是不对的，难道是我们的配置没起作用吗？通过 Swagger 自带的 API 测试工具测试下我们的接口，原来这里请求的 Url 中已经包含了我们定义的版本信息，当我们指定错误的版本信息时，工具也会告诉我们这个版本的接口不存在。