ASP.NET API版本控制

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

http://api/v2/Tasks/ {}的taskid
> URI参数此方法采用以下形式：

http://api/Tasks/ {的TaskID}？V = 2
>内容协商这是在HTTP标头中完成的.

内容类型：application / vnd.taskManagerApp.v2.param.json
>请求标头这也是在HTTP标头中完成的.

x-taskManagerApp-version：2

我个人喜欢第一种方法.你可以阅读Mike Wasson’s ASP.NET Web API: Using Namespaces to Version Web APIs.

许多人修改了Mike Wasson的原始资源.我喜欢ASP.NET Web API 2 book by Jamie Kurtz,Brian Wortman中使用的那个.

由于它有太多移动件,我创建了a sample project at 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 }
);

然后,添加ApiVersionConstraint

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;
    }
}

用法

您只需将RoutePrefix放在控制器上,就完成了.

[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;
    }
}