具有相同路径的Web Api路由具有版本约束的模板

时间:2012-10-18 16:27:44

标签: c# asp.net-web-api asp.net-mvc-routing

我正在使用WebAPI构建api。我正在拍摄的是为每个API版本创建一个外部库,WebAPI应用程序在WebApiConfig

中注册其路由时将查询该API

示例: Api.v1Api.v2


他们将分享类似的功能,但基于标头中传递的version,它将选择正确的API版本:

/{controller}/{action} - HTTP-HEADER: version=1映射到Api.v1.Controller/Action

/{controller}/{action} - HTTP-HEADER: version=2映射到Api.v2.Controller/Action


目标是避免为/{ver}/{controller}/{action}添加前缀。我知道不支持routeTemplates具有相同的值,但我认为我可以将路由绑定到特定的命名空间,并且约束可能有助于解决匹配的问题:

namespace Api.v1
{
    public static class Routing
    {
        public static void MapRoutes(HttpConfiguration config)
        {
            IHttpRoute r = config.Routes.MapHttpRoute(
                name: "",
                routeTemplate: "{controller}/{action}/{id}",
                defaults: new 
                {
                    id = RouteParameter.Optional, 
                    namespaces = new string[] { "Api.v1.Controllers" } 
                },
                constraints: new VersionConstraint(2)
            );
        }
    }
}

public class VersionConstraint : IRouteConstraint
{
    int _version;
    public VersionConstraint(int version)
    {
        _version = version;
    }

    public bool Match(
        HttpContextBase httpContext, 
        Route route, 
        string parameterName, 
        RouteValueDictionary values, 
        RouteDirection routeDirection)
    {
        int version;
        int.TryParse(httpContext.Request.Headers["version"], out version);
        return version == _version;
    }
}

尝试为每条路线注入namespaces也没有真正帮助。 DataTokens属性为null且只读。


知道如何做我正在做的事情?有任何方法可以将相同的路由映射到具有相同名称但具有不同功能和命名空间的不同控制器吗?

2 个答案:

答案 0 :(得分:8)

看看Versioning ASP.NET Web API Services Using HTTP Headers,这似乎可以回答您关于如何根据HTTP标头的前置路由进行路由的问题。

使用自定义IHttpControllerSelector替换默认控制器选择器,该自定义{{3}}根据HTTP标头选择正确的控制器。

答案 1 :(得分:0)