向现有WebAPI添加版本控制

向现有的WebAPI添加版本控制可以通过多种方式实现，以下是几种常见的方法：

方法一：URL版本控制

在URL中包含版本号，这是最常见的方法之一。

示例

https://api.example.com/v1/users
https://api.example.com/v2/users

实现步骤

定义路由：在WebAPI的路由配置中，为不同版本的API定义不同的路由。
版本处理逻辑：在控制器或中间件中处理不同版本的逻辑。

// ASP.NET Core 示例
[RoutePrefix("api/v{version:int}")]
public class UsersController : ControllerBase
{
    [HttpGet]
    [Route("users")]
    public IActionResult GetUsers(int version)
    {
        if (version == 1)
        {
            // 处理版本1的逻辑
        }
        else if (version == 2)
        {
            // 处理版本2的逻辑
        }
        return Ok();
    }
}

方法二：HTTP头版本控制

通过自定义HTTP头来指定API版本。

示例

GET /api/users HTTP/1.1
Host: api.example.com
X-API-Version: 1

实现步骤

定义中间件：创建一个中间件来读取自定义头并设置版本信息。
版本处理逻辑：在控制器或服务中处理不同版本的逻辑。

// ASP.NET Core 示例
public class ApiVersionMiddleware
{
    private readonly RequestDelegate _next;

    public ApiVersionMiddleware(RequestDelegate next)
    {
        _next = next;
    }

    public async Task InvokeAsync(HttpContext context)
    {
        var version = context.Request.Headers["X-API-Version"].FirstOrDefault();
        if (version != null)
        {
            // 设置版本信息到HttpContext.Items中
            context.Items["ApiVersion"] = version;
        }
        await _next(context);
    }
}

方法三：查询参数版本控制

通过URL查询参数来指定API版本。

示例

https://api.example.com/users?version=1
https://api.example.com/users?version=2

实现步骤

定义路由：在WebAPI的路由配置中，为不同版本的API定义不同的查询参数。
版本处理逻辑：在控制器中处理不同版本的逻辑。

// ASP.NET Core 示例
[Route("api/[controller]")]
public class UsersController : ControllerBase
{
    [HttpGet]
    public IActionResult GetUsers([FromQuery] int version = 1)
    {
        if (version == 1)
        {
            // 处理版本1的逻辑
        }
        else if (version == 2)
        {
            // 处理版本2的逻辑
        }
        return Ok();
    }
}

方法四：媒体类型版本控制

通过自定义媒体类型来指定API版本。

示例

GET /api/users HTTP/1.1
Host: api.example.com
Accept: application/vnd.example.v1+json

实现步骤

定义媒体类型：在WebAPI的配置中，为不同版本的API定义不同的媒体类型。
版本处理逻辑：在控制器或服务中处理不同版本的逻辑。

// ASP.NET Core 示例
[ApiController]
[Route("api/[controller]")]
public class UsersController : ControllerBase
{
    [HttpGet]
    [Produces("application/vnd.example.v1+json")]
    public IActionResult GetUsersV1()
    {
        // 处理版本1的逻辑
        return Ok();
    }

    [HttpGet]
    [Produces("application/vnd.example.v2+json")]
    public IActionResult GetUsersV2()
    {
        // 处理版本2的逻辑
        return Ok();
    }
}