在 ASP.NET Core WebAPI如何实现版本控制？

在 ASP.NET Core WebAPI 中实现版本控制（Versioning）是一种常见的做法，用于管理 API 的演进和兼容性。通过版本控制，我们可以在不破坏现有客户端的情况下引入新功能或修改现有功能。以下是实现版本控制的几种常见方法：
1. 使用 URL 路径版本控制

将版本号嵌入到 URL 路径中，比方 /api/v1/controller 和 /api/v2/controller。
实现步骤

安装 Microsoft.AspNetCore.Mvc.Versioning 包：

1. dotnet add package Microsoft.AspNetCore.Mvc.Versioning

复制代码

在 Program.cs 中配置版本控制：

1. var builder = WebApplication.CreateBuilder(args);
3. builder.Services.AddControllers();
4. builder.Services.AddApiVersioning(options =>
5. {
6.     options.DefaultApiVersion = new ApiVersion(1, 0);
7.     options.AssumeDefaultVersionWhenUnspecified = true;
8.     options.ReportApiVersions = true;
9. });
11. var app = builder.Build();
12. app.MapControllers();
13. app.Run();

复制代码

在控制器中指定版本：

1. [ApiController]
2. [ApiVersion("1.0")]
3. [Route("api/v{version:apiVersion}/[controller]")]
4. public class UsersController : ControllerBase
5. {
6.     [HttpGet]
7.     public IActionResult Get()
8.     {
9.         return Ok("Version 1.0");
10.     }
11. }
13. [ApiController]
14. [ApiVersion("2.0")]
15. [Route("api/v{version:apiVersion}/[controller]")]
16. public class UsersV2Controller : ControllerBase
17. {
18.     [HttpGet]
19.     public IActionResult Get()
20.     {
21.         return Ok("Version 2.0");
22.     }
23. }

复制代码

测试：

• /api/v1/users 返回 Version 1.0
  
• /api/v2/users 返回 Version 2.0
  

2. 使用查询字符串版本控制

将版本号作为查询参数传递，比方 /api/users?api-version=1.0。
实现步骤

在 Program.cs 中配置版本控制：

1. builder.Services.AddApiVersioning(options =>
2. {
3.     options.DefaultApiVersion = new ApiVersion(1, 0);
4.     options.AssumeDefaultVersionWhenUnspecified = true;
5.     options.ReportApiVersions = true;
6.     options.ApiVersionReader = new QueryStringApiVersionReader("api-version");
7. });

复制代码

在控制器中指定版本（与 URL 路径版本控制相同）。
测试：

• /api/users?api-version=1.0 返回 Version 1.0
  
• /api/users?api-version=2.0 返回 Version 2.0
  

3. 使用哀求头版本控制

将版本号放在 HTTP 哀求头中，比方 api-version: 1.0。
实现步骤

在 Program.cs 中配置版本控制：

1. builder.Services.AddApiVersioning(options =>
2. {
3.     options.DefaultApiVersion = new ApiVersion(1, 0);
4.     options.AssumeDefaultVersionWhenUnspecified = true;
5.     options.ReportApiVersions = true;
6.     options.ApiVersionReader = new HeaderApiVersionReader("api-version");
7. });

复制代码

在控制器中指定版本（与 URL 路径版本控制相同）。
测试：

• 哀求头中添加 api-version: 1.0，返回 Version 1.0
  
• 哀求头中添加 api-version: 2.0，返回 Version 2.0
  

4. 使用媒体范例版本控制

将版本号嵌入到 Accept 哀求头中，比方 application/json;v=1.0。
实现步骤

在 Program.cs 中配置版本控制：

1. builder.Services.AddApiVersioning(options =>
2. {
3.     options.DefaultApiVersion = new ApiVersion(1, 0);
4.     options.AssumeDefaultVersionWhenUnspecified = true;
5.     options.ReportApiVersions = true;
6.     options.ApiVersionReader = new MediaTypeApiVersionReader("v");
7. });

复制代码

在控制器中指定版本（与 URL 路径版本控制相同）。
测试：

• 哀求头中添加 Accept: application/json;v=1.0，返回 Version 1.0
  
• 哀求头中添加 Accept: application/json;v=2.0，返回 Version 2.0
  

5. 组合多种版本控制方式

你可以同时支持多种版本控制方式，比方 URL 路径和查询字符串。
实现步骤

在 Program.cs 中配置版本控制：

1. builder.Services.AddApiVersioning(options =>
2. {
3.     options.DefaultApiVersion = new ApiVersion(1, 0);
4.     options.AssumeDefaultVersionWhenUnspecified = true;
5.     options.ReportApiVersions = true;
6.     options.ApiVersionReader = ApiVersionReader.Combine(
7.      new QueryStringApiVersionReader("api-version"),
8.      new HeaderApiVersionReader("api-version")
9.   );
10. });

复制代码

在控制器中指定版本（与 URL 路径版本控制相同）。
测试：

• /api/v1/users 返回 Version 1.0
  
• /api/users?api-version=2.0 返回 Version 2.0
  
• 哀求头中添加 api-version: 3.0，返回 Version 3.0
  

总结

在 ASP.NET Core WebAPI 中实现版本控制的方式包括：

• URL 路径版本控制：将版本号嵌入 URL 路径。
  
• 查询字符串版本控制：将版本号作为查询参数传递。
  
• 哀求头版本控制：将版本号放在 HTTP 哀求头中。
  
• 媒体范例版本控制：将版本号嵌入到 Accept 哀求头中。
  
• 组合多种方式：同时支持多种版本控制方式。
  

通过版本控制，我们可以更好地管理 API 的演进，确保新旧版本的兼容性，同时为客户端提供清晰的版本选择。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。