如何修改框架的默认Web API路由?

时间:2013-01-21 16:00:21

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

如果URL中没有提供任何操作,Web API似乎有一个内置的默认逻辑,可以使用HTTP Verb作为操作名称。例如,我有这条路线:

        config.Routes.MapHttpRoute(
            name: "DefaultApiController",
            routeTemplate: "api/{controller}"
        );

以下是我的行动:

    public IEnumerable<Conference> Get()
    {
        ...
    }

    [ActionName("current")]
    public IEnumerable<Conference> GetCurrent()
    {
        ...
    }

当我使用GET动词转到〜/ Conferences 时,会转到“Get()”操作。如果使用POST动词,它将带您进入“发布([FromBody]会议值)”动作......等等。当你试图去〜/ Conferences / GetCurrent时有冲突(即使我有[ActionName(“current”)]在上面):

  

找到与请求匹配的多个操作:   System.Collections.Generic.IEnumerable 1[MyApp.Models.Conference] Get() on type MyApp.Api.ConferencesController System.Collections.Generic.IEnumerable 1 [MyApp.Models.Conference]   MyApp.Api.ConferencesController类型的GetCurrent()

这意味着框架使用StartsWith而不是Equal来确定默认操作。在将动词与动作匹配时,它也会忽略ActionName属性。

我的问题是如何使框架的默认操作完全匹配动词,而不是使用StartsWith逻辑? GET动词应仅匹配Get()动作,而不是Get(),GetCurrent()GetPast()等(特别是当它忽略ActionName属性时)。

修改 为简单起见,我只展示了上面的一条路线。我认为如果我展示所有仍在选秀中的路线可能会有所帮助。我正在尝试获得一个完全正常工作的REST API,同时仍然留有空间来添加我自己的自定义操作:

    public static void Register(HttpConfiguration config)
    {
        config.Routes.MapHttpRoute(
            name: "DefaultApiControllerActionId",
            routeTemplate: "api/{controller}/{action}/{id}",
            defaults: null,
            constraints: new { action = @"^[a-zA-Z]+$", id = @"^\d+$" } // action must start with character
        );

        config.Routes.MapHttpRoute(
            name: "DefaultApiControllerActionName",
            routeTemplate: "api/{controller}/{action}/{name}",
            defaults: null,
            constraints: new { action = @"^[a-zA-Z]+$", name = @"^[a-zA-Z]+$" } // action and name must start with character
        );

        config.Routes.MapHttpRoute(
            name: "DefaultApiControllerId",
            routeTemplate: "api/{controller}/{id}",
            defaults: null,
            constraints: new { id = @"^\d+$" } // id must be all digits
        );

        config.Routes.MapHttpRoute(
            name: "DefaultApiControllerAction",
            routeTemplate: "api/{controller}/{action}",
            defaults: null,
            constraints: new { action = @"^[a-zA-Z]+$" } // action must start with character
        );

        config.Routes.MapHttpRoute(
            name: "DefaultApiController",
            routeTemplate: "api/{controller}"
        );

更新 似乎添加HTTP动词限制有助于:

        config.Routes.MapHttpRoute(
            name: "DefaultApiControllerGet",
            routeTemplate: "api/{controller}",
            defaults: new { action = "Get" },
            constraints: new { httpMethod = new HttpMethodConstraint(HttpMethod.Get) }
        );

        config.Routes.MapHttpRoute(
            name: "DefaultApiControllerPost",
            routeTemplate: "api/{controller}",
            defaults: new { action = "Post" },
            constraints: new { httpMethod = new HttpMethodConstraint(HttpMethod.Post) }
        );

        config.Routes.MapHttpRoute(
            name: "DefaultApiControllerPut",
            routeTemplate: "api/{controller}",
            defaults: new { action = "Put" },
            constraints: new { httpMethod = new HttpMethodConstraint(HttpMethod.Put) }
        );

        config.Routes.MapHttpRoute(
            name: "DefaultApiControllerDelete",
            routeTemplate: "api/{controller}",
            defaults: new { action = "Delete" },
            constraints: new { httpMethod = new HttpMethodConstraint(HttpMethod.Delete) }
        );

1 个答案:

答案 0 :(得分:7)

编辑:由于您对问题进行了大量修改,我需要更改回复:

简而言之 - 使用Web API永远不会开箱即用,因为它默认会调度操作:

  1. 如果{action}是路径数据的一部分,则基于操作名称
  2. 基于HTTP动词
  3. 但是,这两种方法不能在单个控制器中混合,因此您将无法使用来自单个控制器的两种方法分派操作(这是您尝试执行的操作)。

    您有三种方法可以解决此问题:

    1. 重新设计你的资源,这样你就可以分别进行动作名称调度和基于动词的调度(这远非理想)

    2. 为每个嵌套路由手动注册路由。这样您就可以通过HTTP动词继续调度,但路由明确指向特定操作。您可以使用类似AttributeRouting(https://github.com/mccalltd/AttributeRouting)的内容来简化此操作。显而易见的是,你最终会 - 有效 - 每次行动一条路线

    3. 实现一个新的IActionSelector,它允许您在单个控制器中混合基于Verb和基于动作名称的调度。这是最“低级”的解决方案,但看起来就像你想做的事情。我上周发布了一个演练 - http://www.strathweb.com/2013/01/magical-web-api-action-selector-http-verb-and-action-name-dispatching-in-a-single-controller/