C#中如何在路由中间配置可选参数？解决路由模板异常

报错原因 #

你遇到的An optional parameter cannot have default value错误，是因为路由模板中标记为可选的参数（带?的{message?}），不能同时在方法参数里指定默认值。ASP.NET Core路由规则中，路由模板的?已经表示该参数可选，无需再给参数设置默认值，两者同时使用会触发冲突。

另外，你新增的路由{name}/{num}/{message?}和原路由{name}/{message}/{num}存在严重的路由歧义：当请求是三个路径段时，系统无法区分第三个段是原方法的num还是新增方法的message，比如请求api/getData/张三/123/456，系统既可以匹配原方法（把123当message，456当num），也可以匹配新增方法（把123当num，456当message），这种歧义会导致路由匹配逻辑混乱。

正确实现方案 #

要在不修改原路由的前提下，实现message可选的需求，你需要新增一个路径段数量不同的路由，避免歧义，同时规避可选参数与默认值的冲突：

原方法保持不变 #

[ApiController]
[Route("api/getData/")]
public class YourController : ControllerBase
{
    // 原路由：必须提供name、message、num三个参数
    [HttpGet("{name}/{message}/{num}")]
    public async Task<IActionResult> GetAsync(string name, string message, int num)
    {
        // 原有业务逻辑
        return Ok();
    }
}

新增支持message可选的方法 #

新增一个路由仅包含name和num的方法，给message参数设置默认值即可：

// 新增路由：仅需提供name和num，message默认为空字符串
[HttpGet("{name}/{num}")]
public async Task<IActionResult> GetAsyncOptional(string name, int num, string message = "")
{
    // 业务逻辑（可复用原方法的逻辑）
    return Ok();
}

为什么这样可行 #

1. 无路由歧义：原路由是3个路径段，新增路由是2个路径段，ASP.NET Core路由系统会根据路径段数量优先匹配对应方法，不会出现匹配混乱。
2. 规避参数冲突：新增方法的message参数默认值是直接在方法定义中设置，没有在路由模板中标记为可选（?），符合路由规则，不会触发报错。
3. 满足需求：原路由仍然可以正常使用（必须传message），新增路由支持不传message的场景，message自动设为空字符串。

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