在C# WebAPI中实现多版本控制的方法

using Asp.Versioning;
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;
 
namespace MyApiDemo.Common.Extensions
{
    /// <summary>
    /// swagger服务扩展
    /// </summary>
    public static class SwaggerServiceExtensions
    {
        /// <summary>
        /// 控制swagger多版本生成
        /// </summary>
        /// <param name="services"></param>
        /// <param name="apiVersions"></param>
        public static void AddSwaggerGenWithVersioning(this IServiceCollection services, string[] apiVersions)
        {
            services.AddSwaggerGen(m =>
            {
                // XML 注释文件
                string xmlPath = Path.Combine(AppContext.BaseDirectory, "MyApiDemo.xml");
                if (File.Exists(xmlPath))
                    m.IncludeXmlComments(xmlPath, true);
                // 注册每个版本
                foreach (var version in apiVersions)
                {
                    m.SwaggerDoc(version, new OpenApiInfo
                    {
                        Title = $"My API {version.ToUpper()}",
                        Version = version
                    });
                }
 
                // 冲突处理
                m.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());
 
                // 根据控制器上的 ApiVersionAttribute 筛选文档
                m.DocInclusionPredicate((docName, apiDesc) =>
                {
                    if (!apiDesc.TryGetMethodInfo(out var methodInfo)) return false;
 
                    var versions = methodInfo.DeclaringType?
                        .GetCustomAttributes(true)
                        .OfType<ApiVersionAttribute>()
                        .SelectMany(attr => attr.Versions)
                        .Select(v => $"v{v.MajorVersion}")
                        .ToList();
 
                    return versions?.Contains(docName) ?? false;
                });
 
            });
        }
 
    }
}

using Asp.Versioning;
using MyApiDemo.Common.Extensions;
 
var builder = WebApplication.CreateBuilder(args);
 
// 添加服务到容器
builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();
 
// 配置 API 版本控制
builder.Services.AddApiVersioning(options =>
{
    options.DefaultApiVersion = new ApiVersion(1, 0); // 默认版本为 1.0
    options.AssumeDefaultVersionWhenUnspecified = true; // 未指定版本时使用默认版本
    options.ReportApiVersions = true; // 返回支持的版本信息
    options.ApiVersionReader = ApiVersionReader.Combine(
        new QueryStringApiVersionReader("version"), // 从查询字符串读取版本号
        new UrlSegmentApiVersionReader(), // 从 URL 路径读取版本号
        new HeaderApiVersionReader("X-API-Version"), // 从请求头读取版本号
        new MediaTypeApiVersionReader("version") // 从媒体类型读取版本号
    );
});
 
// 配置 Swagger 多版本生成
var apiVersions = new[] { "v1", "v2" };
builder.Services.AddSwaggerGenWithVersioning(apiVersions);
 
var app = builder.Build();
 
// 启用 Swagger 和 Swagger UI
app.UseSwagger();
app.UseSwaggerUI(options =>
{
    foreach (var version in apiVersions)
    {
        options.SwaggerEndpoint($"/swagger/{version}/swagger.json", $"My API {version.ToUpper()}");
    }
});
 
app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();
app.Run();

// API v1
[ApiController]
[Route("api/v{version:apiVersion}/[controller]")]
[ApiVersion("1.0")]
public class ProductsControllerV1 : ControllerBase
{
    [HttpGet]
    public IActionResult GetProducts()
    {
        return Ok(new { Message = "This is version 1.0" });
    }
}
 
// API v2
[ApiController]
[Route("api/v{version:apiVersion}/[controller]")]
[ApiVersion("2.0")]
public class ProductsControllerV2 : ControllerBase
{
    [HttpGet]
    public IActionResult GetProducts()
    {
        return Ok(new { Message = "This is version 2.0 with new features!" });
    }
}