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 }
         );

所以，在我的控制器中，我有：

    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 会给我错误

找到多个与请求匹配的操作：...

我明白为什么会这样 - 路由只是定义了哪些 URL 是有效的，但是在函数匹配方面，Get(int id) 和 ByCategoryId(int id) 都匹配 api/{controller}/{id}，这是 混淆框架。

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

Answer 1

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

所以，你应该：

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

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

3. 向您的“DefaultApi”添加一个命名操作，以告诉路由引擎要输入哪个操作。否则，一旦您的控制器中有多个操作，引擎将不知道要使用哪个操作并抛出“找到与请求匹配的多个操作：...”。然后要使其与您的 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 }
);

还有你的控制器：

[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" };
}

Answer 2

属性路由可以解决你的问题

控制器

[Route("api/category/{categoryId}")]
public IEnumerable<Order> GetCategoryId(int categoryId) { ... }

jQuery 中的 URI

api/category/1

路由配置

using System.Web.Http;

namespace WebApplication
{
    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API routes
            config.MapHttpAttributeRoutes();

            // Other Web API configuration not shown.
        }
    }
}

并且您的默认路由作为默认基于约定的路由

工作

控制器

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

Jquery 中的 URI

/api/records/1 

路由配置

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Attribute routing.
        config.MapHttpAttributeRoutes();

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

查看文章了解更多信息Attribute routing and onvention-based routing here & this

Answer 3

试试这个。

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

        var json = config.Formatters.JsonFormatter;
        json.SupportedMediaTypes.Add(new System.Net.Http.Headers.MediaTypeHeaderValue("application/json"));
        config.Formatters.Remove(config.Formatters.XmlFormatter);

        // Web API routes
        config.MapHttpAttributeRoutes();

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

        );
    }
}

Answer 4

可能的原因也可能是你没有从 ApiController 继承 Controller。 发生在我身上花了一段时间才明白。

Answer 5

要区分路由，请尝试添加 id 必须为数字的约束：

RouteTable.Routes.MapHttpRoute(
         name: "DefaultApi",
         routeTemplate: "api/{controller}/{id}",
         constraints: new { id = @"\d+" }, // Only matches if "id" is one or more digits.
         defaults: new { id = System.Web.Http.RouteParameter.Optional }
         );