ASP.NET API 版本控制

我是 ASP.NET 新手，但我希望为即将开始的新 API 实现一些版本控制。

我什至不确定我正在寻找的是否可能，但我正在寻找使用标头变量的非常干净的版本方法。

理想情况下，我希望能够在代码结构中拥有一个版本文件夹，并在其中包含包含不同 API 版本的不同文件夹。 每个版本文件夹都将包含核心 API 代码的完整副本，因此我知道永远不会有任何冲突等。我知道这会使代码膨胀，但值得保持它非常干净，并且只会超过 2-3 个激活的 API 版本。

我在互联网上找到了许多标头示例，但它们都要求类位于不同的命名空间中，如果我正在执行代码的完整副本，那么每次复制时都必须重命名所有类是不切实际的。

我想做的事情可能吗？或者在处理多个类时是否有更干净的解决方案？

有四种基本方法来版本化 RESTful 方式 -

1. URI 路径 此方法采用以下形式：

   http://api/v2/任务/{TaskId}

2. URI 参数 此方法采用以下形式：

   http://api/任务/{任务ID}?v=2

3. 内容协商 这是在 HTTP 标头中完成的。

   内容类型：application/vnd.taskManagerApp.v2.param.json

4. 请求标头 这也是在 HTTP 标头中完成的。

   x-taskManagerApp-版本：2

我个人喜欢第一种方法。你可以阅读Mike Wasson 的 ASP.NET Web API：使用命名空间对 Web API 进行版本控制.

许多人修改了 Mike Wasson 的原始来源。我喜欢其中使用的一个ASP.NET Web API 2 书籍，作者：Jamie Kurtz、Brian Wortman.

由于它有太多移动部件，我创建了GitHub 上的示例项目.

config.Routes.MapHttpRoute(
   name: "DefaultApi",
   routeTemplate: "api/{version}/{controller}",
   defaults: new { version = "v2" }
);

config.Routes.MapHttpRoute(
   name: "DefaultApiWithId",
   routeTemplate: "api/{version}/{controller}/{id}",
   defaults: new { id = RouteParameter.Optional }
);

然后，你添加Api版本约束

public class ApiVersionConstraint : IHttpRouteConstraint
{
    public ApiVersionConstraint(string allowedVersion)
    {
        AllowedVersion = allowedVersion.ToLowerInvariant();
    }

    public string AllowedVersion { get; private set; }

    public bool Match(HttpRequestMessage request, IHttpRoute route, string parameterName,
        IDictionary<string, object> values, HttpRouteDirection routeDirection)
    {
        object value;
        if (values.TryGetValue(parameterName, out value) && value != null)
        {
            return AllowedVersion.Equals(value.ToString().ToLowerInvariant());
        }
        return false;
    }
}

Usage

你只需放置路由前缀在控制器上，你就完成了。

[RoutePrefix("api/{apiVersion:apiVersionConstraint(v1)}/values")]
public class ValuesController : ApiController
{
    // GET api/v1/values
    [Route("")]
    public IEnumerable<string> Get()
    {
        return new string[] { "v1-value1", "v1-value2" };
    }

    // GET api/v1/values/5
    [Route("{id}")]
    public string Get(int id)
    {
        return "v1-value-" + id;
    }
}