如何解决Web API中HttpGet路由端点匹配冲突问题？

这个问题的根本原因是ASP.NET Core的路由匹配系统默认按照路由注册的先后顺序做匹配，且无约束的动态路径参数{serialNumber}可以匹配任意字符串，所以当api/summary请求进入时，会优先命中先注册的动态参数路由，把summary当做参数值传入。

对应解决方案如下：

• 调整Action定义顺序
  把[HttpGet("summary")]对应的Action方法写到[HttpGet("{serialNumber}")]对应的Action方法前面。同Controller内的属性路由默认按照Action的定义顺序注册，固定路径路由放在前面就会被优先匹配，不会走到后面的动态参数路由。
• 显式设置路由优先级
  通过HttpGet特性的Order参数指定路由优先级，数值越小优先级越高，不受Action定义顺序影响：

  // 固定路由优先级设为最高
  [HttpGet("summary", Order = 0)]
  public IActionResult GetSummary()
  {
      // 业务逻辑
  }
  
  // 动态路由优先级设为更低
  [HttpGet("{serialNumber}", Order = 1)]
  public IActionResult GetBySerialNumber(string serialNumber)
  {
      // 业务逻辑
  }
  

• 给动态参数添加路由约束
  如果serialNumber有固定的格式规则（比如纯数字、固定长度、指定前缀等），可以给参数添加路由约束，限定动态路由的匹配范围，从根源上避免匹配到固定路径：

  // 示例：限制serialNumber必须是16位的十六进制字符
  [HttpGet("{serialNumber:regex(^[0-9A-Fa-f]{16}$)}")]
  public IActionResult GetBySerialNumber(string serialNumber)
  {
      // 业务逻辑
  }
  

  加了约束后，summary字符串不符合参数格式要求，就不会命中动态路由，请求会自动匹配到summary接口。
• 给动态路由增加固定前缀
  调整动态参数路由的规则，增加一层固定路径前缀，让两个路由的路径规则完全不重叠：

  [HttpGet("serial/{serialNumber}")]
  public IActionResult GetBySerialNumber(string serialNumber)
  {
      // 业务逻辑
  }
  

  调整后动态路由的匹配路径为api/serial/xxx，和api/summary完全区分，不会再有匹配冲突。

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