获取属性路由模板列表asp.net webapi 2.2

时间:2015-03-30 01:26:20

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

我使用WebApi 2.2在C#中运行.NET项目。

我正在使用属性注册所有路线。我想要做的是以编程方式将所有属性路径模板检索为字符串。

类似于:var routeTemplates = System.Web.Routing.RouteTable.Routes.Select(x => x.RouteTemplates);

当我将手表放在ControllerContext.Configuration.Routes

上时,我能够看到所有路线

但是,我似乎无法访问我的代码中的路由,因为它们是受保护的内部。 我如何得到它们?

我附上了一个屏幕截图,其中显示了我在locals watch上看到的我需要了解的值。

The data I want to get at

1 个答案:

答案 0 :(得分:11)

在Web API中注册属性路由时,您可以注册自定义IDirectRouteProvider以自定义属性路由的查找方式。在该自定义IDirectRouteProvider中,您可以委托所有" hard"使用默认实现DefaultDirectRouteProvider,查看所有控制器和操作以计算属性路由列表,然后对所有这些努力工作表示赞赏。

要全部设置,首先要创建一个新的" observable"代表其所有工作的直接路线提供者:

public class ObservableDirectRouteProvider : IDirectRouteProvider
{
    public IReadOnlyList<RouteEntry> DirectRoutes { get; private set; }

    public IReadOnlyList<RouteEntry> GetDirectRoutes(HttpControllerDescriptor controllerDescriptor, IReadOnlyList<HttpActionDescriptor> actionDescriptors, IInlineConstraintResolver constraintResolver)
    {
        var realDirectRouteProvider = new DefaultDirectRouteProvider();
        var directRoutes = realDirectRouteProvider.GetDirectRoutes(controllerDescriptor, actionDescriptors, constraintResolver);
        // Store the routes in a property so that they can be retrieved later
        DirectRoutes = DirectRoutes?.Union(directRoutes).ToList() ?? directRoutes;
        return directRoutes;
    }
}

然后在您应用的初创公司的WebApiConfig.Register方法中使用这个新类:

public static class WebApiConfig
{
    public static ObservableDirectRouteProvider GlobalObservableDirectRouteProvider = new ObservableDirectRouteProvider();

    public static void Register(HttpConfiguration config)
    {
        // Web API configuration and services

        // Web API routes
        config.MapHttpAttributeRoutes(GlobalObservableDirectRouteProvider);

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

请注意,数据最终存储在静态字段中。这是必需的,因为WebApiConfig.Register中的代码不会立即调用 - 稍后会在global.asax.cs中调用它。因此,要观察所有内容的结果,请向Application_Start添加一些代码:

protected void Application_Start()
{
    AreaRegistration.RegisterAllAreas();
    GlobalConfiguration.Configure(WebApiConfig.Register);
    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    RouteConfig.RegisterRoutes(RouteTable.Routes);
    BundleConfig.RegisterBundles(BundleTable.Bundles);

    var allDirectRoutes = WebApiConfig.GlobalObservableDirectRouteProvider.DirectRoutes;
    // now do something with 'allDirectRoutes'
}

在我写的一个小测试中,我得到了这些值:

enter image description here

你有它,应用程序中所有属性路线的列表!

注意:如果您想弄清楚每条属性路线的来源,那么在每条路线的DataTokens属性中会有其他数据。