c# - 如何修改框架的默认 Web API 路由？

Question

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

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

这是我的行为:

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

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

当我使用 GET 动词转到 ~/Conferences 时，它会将您带到“Get()”操作。如果使用 POST 动词，它会将您带到“Post([FromBody]Conference value)”操作……等等。尽管当您尝试转到 ~/Conferences/GetCurrent 时存在冲突(即使我在顶部有 [ActionName("current")]):

Multiple actions were found that match the request: System.Collections.Generic.IEnumerable1[MyApp.Models.Conference]
Get() on type MyApp.Api.ConferencesController
System.Collections.Generic.IEnumerable1[MyApp.Models.Conference] GetCurrent() on type MyApp.Api.ConferencesController

这意味着框架使用 StartsWith 而不是 Equal 来确定默认操作。在将动词与 Action 匹配时，它还会忽略 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) }
        );

Answer 1

编辑:由于您对问题做了很大的修改，我需要更改回复:

简而言之 - 这永远不会与 Web API 开箱即用，因为它会默认分派(dispatch)操作:

1. 如果 {action} 是路线数据的一部分，则基于 Action 名称
2. 基于 HTTP 动词

但是，这两种方法不能在单个 Controller 中混合使用，因此您将无法从单个 Controller 使用这两种方法来分派(dispatch)操作(这正是您要尝试做的)。

您可以通过三种方式解决此问题:

1. 重做您的资源，以便您有单独的资源用于 Action 名称调度和基于动词的调度(这远非理想)

2. 为每个嵌套路由手动注册路由。这样你就可以继续通过 HTTP 动词进行调度，但路由明确指向特定的操作。您可以使用类似 AttributeRouting (https://github.com/mccalltd/AttributeRouting) 的东西来简化它。缺点显然是你最终 - 实际上 - 每个 Action 一条路线

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