如何处理 ASP.NET Web API 中的分层路由？

Question

目前我有两个控制器

1 - 父控制器

2 - 子控制器

我像这样访问我的父控制器

someurl\parentcontroller

现在我想像这样访问我的孩子控制器

someurl\parentcontroller\1\childcontroller

最后一个 url 应该返回特定父级的所有子级。

我的 global.asax 文件中目前有这条路线

routes.MapHttpRoute ("Route1", "{controller}/{id}", new { id = RouteParameter.Optional });

我不确定如何实现我的parent\id\child 层次结构。我应该如何配置我的路由来实现这一点？想法？

Answer 1

如下配置路由。 {param} 是可选的（根据需要使用）：

routes.MapHttpRoute(
           name: "childapi",
           routeTemplate: "api/Parent/{id}/Child/{param}",
           defaults: new { controller = "Child", param = RouteParameter.Optional }
  );

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

然后调用子 API 为 /api/Parent/1/child 父级可以简单地称为 /api/Parent/

子控制器：

    public class ChildController : ApiController
    {     
        public string Get(int id)
        {
          //the id is id between parent/{id}/child  
          return "value";
        }
        .......
    }

Answer 2

从 Web API 2 开始，您现在可以使用路由属性来定义每个方法的自定义路由，

[Route("api/customers/{id:guid}/orders")]
public IEnumerable<Order> GetCustomerOrders(Guid id) {
   return new Order[0];
}

你还需要在WebApiConfig.Register()初始化方法中加入下面一行，

  config.MapHttpAttributeRoutes();

全文， http://www.asp.net/web-api/overview/web-api-routing-and-actions/attribute-routing-in-web-api-2

Answer 3

我想以更通用的方式处理这个问题，而不是像 Abhijit Kadam 那样直接使用 controller = "Child" 连接 ChildController。我有几个子控制器，不想为每个子控制器映射一个特定的路由，一遍又一遍地使用controller = "ChildX" 和controller = "ChildY"。

我的WebApiConfig 看起来像这样：

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

我的父控制器非常标准，并且匹配上面的默认路由。示例子控制器如下所示：

public class CommentController : ApiController
{
    // GET api/product/5/comment
    public string Get(ParentController parentController, string parentId)
    {
        return "This is the comment controller with parent of "
        + parentId + ", which is a " + parentController.ToString();
    }
    // GET api/product/5/comment/122
    public string Get(ParentController parentController, string parentId,
        string id)
    {
        return "You are looking for comment " + id + " under parent "
            + parentId + ", which is a "
            + parentController.ToString();
    }
}
public enum ParentController
{
    Product
}

我的实现的一些缺点

• 如您所见，我使用了enum，所以我仍然需要在两个不同的地方管理父控制器。它可以很容易地成为一个字符串参数，但我想阻止 api/crazy-non-existent-parent/5/comment/122 工作。
• 可能有一种方法可以使用反射或其他方式即时执行此操作，而无需单独管理，但目前这对我有用。
• 不支持孩子的孩子。

可能有更好的解决方案，更通用，但就像我说的，这对我有用。

Answer 4

除了使用默认 mvc 路由之外，还有一个选项是查看属性路由 - https://github.com/mccalltd/AttributeRouting。虽然它的工作量更大，但当您需要设计复杂的路线时，装饰单个动作方法提供了很大的灵活性。您还可以将它与标准 MVC 路由结合使用。