ASP.NET Web API嵌套路由配置：多控制器路由冲突解决

问题 #

开发了一个汽车相关的ASP.NET REST API，包含WheelsController和WheelNutsController，后续还需添加BrakeController等控制器。需要实现以下嵌套路由访问：

目标路由 #

• WheelsController方法：
  • GET /car/wheels/ - 获取所有车轮
  • GET /car/wheels/{wheelId} - 获取单个车轮
  • DELETE /car/wheels/{wheelId} - 删除单个车轮
  • GET /car/wheels/{wheelId}/speed - 获取单个车轮的转速
• WheelNutsController方法：
  • GET /car/wheels/{wheelId}/wheelnuts - 获取指定车轮的所有螺母
  • POST /car/wheels/{wheelId}/wheelnuts/{nutId}/tighten - 执行螺母拧紧操作

使用以下传统路由配置时，出现Multiple controller types were found错误：

config.Routes.MapHttpRoute(
    "SettlementSubAPI",
    "api/Wheels/{wheelId}/{controller}/{id}",
    new { id = RouteParameter.Optional , controller  = "WheelNuts"}
 );
 config.Routes.MapHttpRoute(
    "3wayroute",
    "api/{controller}/{id}/{AttributeName}",
    new { AttributeName = RouteParameter.Optional }
 );
 config.Routes.MapHttpRoute(
        "DefaultAPI",
        "api/{controller}/{id}",
        new {  id = RouteParameter.Optional }
 );

当前使用.NET Framework 4.7.2，需解决嵌套路由配置问题，同时支持后续扩展其他控制器的类似路由。

解决方案 #

1. 启用属性路由 #

传统路由的模糊匹配规则是导致冲突的核心原因，推荐使用属性路由来实现自定义嵌套路由，.NET Framework 4.7.2的Web API完全支持该特性。首先在WebApiConfig.cs中启用属性路由：

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // 启用属性路由（优先级高于传统路由）
        config.MapHttpAttributeRoutes();

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

2. 为控制器添加属性路由 #

WheelsController

通过[RoutePrefix]定义控制器的基础路由，再为每个方法单独标注具体路由：

[RoutePrefix("car/wheels")]
public class WheelsController : ApiController
{
    // GET /car/wheels/
    [Route("")]
    [HttpGet]
    public IHttpActionResult GetAllWheels()
    {
        // 业务逻辑实现
        return Ok();
    }

    // GET /car/wheels/{wheelId}
    [Route("{wheelId:int}")]
    [HttpGet]
    public IHttpActionResult GetWheel(int wheelId)
    {
        // 业务逻辑实现
        return Ok();
    }

    // DELETE /car/wheels/{wheelId}
    [Route("{wheelId:int}")]
    [HttpDelete]
    public IHttpActionResult DeleteWheel(int wheelId)
    {
        // 业务逻辑实现
        return Ok();
    }

    // GET /car/wheels/{wheelId}/speed
    [Route("{wheelId:int}/speed")]
    [HttpGet]
    public IHttpActionResult GetWheelSpeed(int wheelId)
    {
        // 业务逻辑实现
        return Ok();
    }
}

WheelNutsController

针对嵌套在车轮下的资源，可直接在方法上定义完整路由，或通过[RoutePrefix]复用父级参数：

[RoutePrefix("car/wheels/{wheelId:int}/wheelnuts")]
public class WheelNutsController : ApiController
{
    // GET /car/wheels/{wheelId}/wheelnuts
    [Route("")]
    [HttpGet]
    public IHttpActionResult GetWheelNuts(int wheelId)
    {
        // 业务逻辑实现
        return Ok();
    }

    // POST /car/wheels/{wheelId}/wheelnuts/{nutId:int}/tighten
    [Route("{nutId:int}/tighten")]
    [HttpPost]
    public IHttpActionResult TightenNut(int wheelId, int nutId)
    {
        // 业务逻辑实现
        return Ok();
    }
}

3. 后续扩展支持 #

新增BrakeController等控制器时，只需按照相同的属性路由规则配置即可，例如：

[RoutePrefix("car/brakes")]
public class BrakeController : ApiController
{
    // GET /car/brakes/
    [Route("")]
    [HttpGet]
    public IHttpActionResult GetAllBrakes()
    {
        // 业务逻辑实现
        return Ok();
    }

    // GET /car/wheels/{wheelId}/brakes
    [Route("../wheels/{wheelId:int}/brakes")]
    [HttpGet]
    public IHttpActionResult GetWheelBrake(int wheelId)
    {
        // 业务逻辑实现
        return Ok();
    }
}

错误原因说明 #

你之前的传统路由配置存在匹配冲突：例如请求/api/Wheels/1/WheelNuts时，第一条路由和第三条路由都可能匹配到对应的控制器，导致路由系统无法确定目标控制器，从而抛出Multiple controller types were found错误。属性路由通过明确的路由定义，彻底避免了这种模糊匹配问题。

内容的提问来源于stack exchange，提问作者azrael.pl