asp.net - Web API 路由 - api/{controller}/{action}/{id} "dysfunctions"api/{controller}/{id}

Question

我在 Global.asax 中有默认路由:

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

我希望能够针对特定功能，因此我创建了另一条路线:

RouteTable.Routes.MapHttpRoute(
         name: "WithActionApi",
         routeTemplate: "api/{controller}/{action}/{id}",
         defaults: new { id = System.Web.Http.RouteParameter.Optional }
         );

所以，在我的 Controller 中，我有:

    public string Get(int id)
    {
        return "object of id id";
    }        

    [HttpGet]
    public IEnumerable<string> ByCategoryId(int id)
    {
        return new string[] { "byCategory1", "byCategory2" };
    }

调用 .../api/records/bycategoryid/5 会给我我想要的。 但是，调用 .../api/records/1 会给我错误

Multiple actions were found that match the request: ...

我明白为什么 - 路由只是定义哪些 URL 是有效的，但是当涉及到函数匹配时，Get(int id) 和 ByCategoryId(int id) code> 匹配 api/{controller}/{id}，这就是混淆框架的原因。

我需要做什么才能让默认 API 路由再次工作，并保留带有 {action} 的路由？我想创建一个名为 RecordByCategoryIdController 的不同 Controller 来匹配默认 API 路由，为此我将请求 .../api/recordbycategoryid/5。然而，我发现这是一个“肮脏”(因此不令人满意)的解决方案。我已经寻找过这方面的答案，但没有任何关于使用带有 {action} 的路线的教程甚至提到这个问题。

Answer 1

路由引擎使用与您添加规则相同的顺序。一旦它获得第一个匹配的规则，它将停止检查其他规则并以此来搜索 Controller 和操作。

所以，你应该:

1. 将您的特定规则放在一般规则(例如默认规则)之前，这意味着使用 RouteTable.Routes.MapHttpRoute 首先映射“WithActionApi”，然后映射“DefaultApi”。

2. 删除“WithActionApi”规则的 defaults: new { id = System.Web.Http.RouteParameter.Optional } 参数，因为一旦 id 是可选的，url 就会像“/api/{part1}/{part2}”永远不会进入“DefaultApi”。

3. 将命名操作添加到“DefaultApi”中，以告诉路由引擎要输入哪个操作。否则，一旦 Controller 中有多个操作，引擎将不知道要使用哪一个，并抛出“发现多个与请求匹配的操作:...”。然后，为了使其与您的 Get 方法匹配，请使用 ActionNameAttribute .

所以你的路线应该是这样的:

// Map this rule first
RouteTable.Routes.MapRoute(
     "WithActionApi",
     "api/{controller}/{action}/{id}"
 );

RouteTable.Routes.MapRoute(
    "DefaultApi",
    "api/{controller}/{id}",
    new { action="DefaultAction", id = System.Web.Http.RouteParameter.Optional }
);

还有你的 Controller :

[ActionName("DefaultAction")] //Map Action and you can name your method with any text
public string Get(int id)
{
    return "object of id id";
}        

[HttpGet]
public IEnumerable<string> ByCategoryId(int id)
{
    return new string[] { "byCategory1", "byCategory2" };
}