MVC Web API路由异常：GetReservationsByDate误路由至默认Get方法

这个问题我碰到过好多次，核心原因是Web API的默认路由规则没办法区分你的GetReservationsByDate和无参的GetReservations方法，导致请求被错误路由到了默认Get方法上。下面给你几个具体的解决方案：

方案1：使用属性路由（推荐） #

属性路由可以给每个API方法指定唯一的路由模板，彻底避免路由冲突。

首先，确保你在WebApiConfig.cs中启用了属性路由：

public static void Register(HttpConfiguration config)
{
    // 启用属性路由
    config.MapHttpAttributeRoutes();

    // 保留默认路由（可选）
    config.Routes.MapHttpRoute(
        name: "DefaultApi",
        routeTemplate: "api/{controller}/{id}",
        defaults: new { id = RouteParameter.Optional }
    );
}

然后给GetReservationsByDate方法添加[Route]属性，指定专属路由：

// GET: api/Reservations
public IQueryable<Reservation> GetReservations()
{
    return db.Reservations;
}

[ResponseType(typeof(ReservationDTO))]
[Route("api/Reservations/ForCustomer/{customerId}")] // 也可以给这个方法加上属性路由，避免潜在冲突
public IHttpActionResult GetReservationsForCustomer(int customerId)
{
    // 你的业务逻辑
}

[ResponseType(typeof(IEnumerable<Reservation>))]
[Route("api/Reservations/ByDate/{reservationDate}")]
public IHttpActionResult GetReservationsByDate(DateTime reservationDate)
{
    var reservations = db.Reservations.Where(r => r.ReservationDate == reservationDate);
    if (!reservations.Any())
    {
        return NotFound();
    }
    return Ok(reservations);
}

这样你就可以通过GET api/Reservations/ByDate/2024-05-20来调用这个方法了。如果想用查询字符串传递日期（比如GET api/Reservations/ByDate?reservationDate=2024-05-20），可以把路由改成：

[Route("api/Reservations/ByDate")]
public IHttpActionResult GetReservationsByDate([FromUri] DateTime reservationDate)
{
    // 业务逻辑
}

方案2：修改全局路由模板包含Action名称 #

如果不想用属性路由，可以修改全局路由规则，让路由包含Action名称，这样Web API会根据URL中的Action名称匹配对应的方法：

在WebApiConfig.cs中添加一个新的路由：

public static void Register(HttpConfiguration config)
{
    // 带Action的路由（优先级高于默认路由）
    config.Routes.MapHttpRoute(
        name: "ActionApi",
        routeTemplate: "api/{controller}/{action}/{id}",
        defaults: new { id = RouteParameter.Optional }
    );

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

之后你就可以通过GET api/Reservations/GetReservationsByDate?reservationDate=2024-05-20来调用目标方法。如果想把日期放在URL路径里，建议把方法参数名改成id，或者调整路由模板为api/{controller}/{action}/{reservationDate}。

为什么会出现这个问题？ #

Web API的默认路由匹配逻辑是：

1. 先匹配HTTP方法（比如GET）
2. 再匹配参数数量和类型
   如果你的GetReservationsByDate方法参数是简单类型（比如DateTime），而默认路由的{id}是可选参数，Web API会认为这个请求可以匹配无参的GetReservations方法，从而把请求路由过去，导致你看到的错误。

内容的提问来源于stack exchange，提问作者Matt G