ASP.NET树形结构节点的路由匹配方案及RESTful暴露方式咨询

一、ASP.NET Core路由的最优实现方案 #

无需依赖通配符手动解析，可通过以下两种更规范的方式实现需求：

1. 自定义路由约束+模型绑定 #

这种方式能严格匹配{nodeId:int}/nodes的重复结构，避免非法路径：

第一步：创建自定义路由约束

public class NodeHierarchyConstraint : IRouteConstraint
{
    public bool Match(HttpContext httpContext, IRouter route, string routeKey, RouteValueDictionary values, RouteDirection routeDirection)
    {
        if (!values.TryGetValue(routeKey, out var value))
            return false;
        var path = value.ToString();
        if (string.IsNullOrEmpty(path))
            return false;
            
        var segments = path.Split('/');
        // 验证格式：nodeId/nodes/nodeId/nodes/.../nodeId（最后一段必须是nodeId）
        for (int i = 0; i < segments.Length; i++)
        {
            if (i % 2 == 0 && !int.TryParse(segments[i], out _))
                return false;
            if (i % 2 == 1 && segments[i] != "nodes")
                return false;
        }
        return segments.Length % 2 == 1;
    }
}

第二步：注册路由约束

在Program.cs或Startup.cs中添加约束映射：

builder.Services.Configure<RouteOptions>(options =>
{
    options.ConstraintMap.Add("nodehierarchy", typeof(NodeHierarchyConstraint));
});

第三步：定义接口路由

[HttpGet("nodes/{hierarchy:nodehierarchy}")]
public IActionResult GetHierarchy([FromRoute] string hierarchy)
{
    // 解析路径为节点ID集合
    var nodeIds = hierarchy.Split('/')
                           .Where((s, i) => i % 2 == 0)
                           .Select(int.Parse);
    // 后续业务逻辑
    return Ok(nodeIds);
}

示例匹配路径：/nodes/1/nodes/2/nodes/3，解析后nodeIds为[1,2,3]。

2. 扁平路径+剩余路径捕获 #

如果可以简化路径格式（去掉重复的/nodes），直接用/nodes/1/2/3表示层级，路由实现更简洁：

[HttpGet("nodes/{*nodeIds:int}")]
public IActionResult GetNodeHierarchy([FromRoute] string nodeIds)
{
    var idList = nodeIds.Split('/').Select(int.Parse);
    return Ok(idList);
}

这种方式无需自定义约束，ASP.NET Core会自动捕获/nodes/后的所有路径段，解析为节点ID集合。

二、RESTful风格替代设计建议 #

考虑到nodeId仅在父节点范围内唯一，推荐两种更简洁的RESTful设计：

• 查询参数传递层级：将节点层级放在查询参数中，避免复杂路径，也更易被API工具识别：

  [HttpGet("nodes")]
  public IActionResult GetNodeByHierarchy([FromQuery] IEnumerable<int> nodeHierarchy)
  {
      // 示例请求：/nodes?nodeHierarchy=1&nodeHierarchy=2&nodeHierarchy=3
      return Ok(nodeHierarchy);
  }
  

• 扁平路径表示层级：即上面提到的/nodes/1/2/3格式，符合RESTful简洁性原则，也便于用户理解路径对应的节点层级关系。

三、OpenAPI标准支持情况 #

OpenAPI 3.0+对这类场景的支持分为两种情况：

• 对于带重复/nodes段的复杂路径：OpenAPI无法直接定义无限重复的路径段，只能通过定义多个可选路径参数（如最多支持5层）或使用{*path}通配符，然后在接口描述中说明参数格式。但多数客户端生成器对通配符参数的支持有限，不推荐。
• 对于查询参数或扁平路径的设计：OpenAPI可以完美支持。查询参数方式可直接定义nodeHierarchy为array[int]类型；扁平路径方式可使用{*nodeIds}参数，在描述中说明其为/分隔的整数数组，主流客户端生成器（如NSwag、Swagger Codegen）都能正确识别并生成对应代码。

内容的提问来源于stack exchange，提问作者Ar Es