版本化ASP.NET Core WebApi

喵叔

发布于 2021-11-17 10:17:04

4430

发布于 2021-11-17 10:17:04

文章被收录于专栏：喵叔's 专栏

大部分使用Web API的网站都会使用版本化Web API，这是因为当我们升级Web API的时候并不能保证所有的客户端使用的都是最新的Web API，有些旧版本的客户端很有可能使用的某个甚至某几个在新的Web API 中已经废除的接口。如果这时我们部署新的Web API的话，旧版本的客户端就无法使用了。因此Web API 的版本化就出来了。下面我们就来一步一步的实现Web API的版本化。首先我们需要引如Microsoft.AspNetCore.Mvc.Versioning包，通过 Visual Studio的nuget安装即可。当包成功添加到项目之后，就需要在 Startup的ConfigureServices方法中将ApiVersioning注入到容器中，代码如下：

//more code
//...
using Microsoft.AspNetCore.Mvc.Versioning
public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
    	//more code
    	//...
        services.AddControllers();
        //注入ApiVersioning
        services.AddApiVersioning();
        //more code
        //...
    }
}

上面的代码只不过是默认的方法，在实际项目中我们会对它做全局配置，代码如下：

//more code
//...
using Microsoft.AspNetCore.Mvc.Versioning
public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
    	//more code
    	//...
        services.AddControllers();
        services.AddApiVersioning(p =>
        {
        	//在请求的响应头部显示所有拥有的版本号
            p.ReportApiVersions = true;
            //在请求链接中未设置版本时使用默认版本
            p.AssumeDefaultVersionWhenUnspecified = true;
            //默认版本号
            p.DefaultApiVersion = new ApiVersion(1, 0);
        });
        //more code
        //...
    }
}

接下来就是使用版本号了，我们需要在Controller上面加上属性ApiViersion，并指定版本号，例如下面的代码：

[ApiVersion("2.0")]
[ApiController]
[Route("api/[controller]")]
public class TestController : ControllerBase
{
    [HttpGet]
    public IActionResult Get()
    {
        //more code
        //....
    }
}

从上面的代码中可以看出，我们在TestController控制器上标记了这个控制器的版本是2.0，那么我们要访问这个控制器的化就需要指定版本号，就像下面的连接那样：接下来如何访问呢？可以通过如下链接：http://localhost:3345/api/test?api-version=2.0。 2.0版本的Get是有了，那么1.0的 Get呢？代码应该怎么写呢？一般来说在实际开发中会用两个命名空间来表示相应的版本号，例如下面这样的代码：

//1.0版本
namespace TestVersion.Controllers.v1
{
    [ApiVersion("1.0")]
    [ApiController]
    [Route("api/[controller]")]
    public class TestController : ControllerBase
    {
	    [HttpGet]
	    public IActionResult Get()
	    {
	        //more code
	        //....
	    }
    }
}
//2.0版本
namespace TestVersion.Controllers.v2
{
    [ApiVersion("2.0")]
    [ApiController]
    [Route("api/[controller]")]
    public class TestController : ControllerBase
    {
        [HttpGet]
	    public IActionResult Get()
	    {
	        //more code
	        //....
	    }
    }
}

上面的代码解决了不同版本号的问题，但是这种方法并不完美，它不符合Restful规范，我们可以使用路由指定版本号，下面就是修正后的代码：

[ApiVersion("2.0")]
[ApiController]
[Route("api/{version:apiVersion}/[controller]")]
public class TestController : ControllerBase
{
    [HttpGet]
 public IActionResult Get()
 {
     //more code
     //....
 }
}

在代码中，我们将 [Route(“api/[controller]”)] 修改为了成了 [Route(“api/{version:apiVersion}/[controller]”)]，那么我们访问的时候地址将变为：http://localhost:3345/api/1.0/test。

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2021/11/16 ，如有侵权请联系 cloudcommunity@tencent.com 删除

网站