如何在ASP.NET Core RESTFul API中新增带name查询参数的GET端点

你遇到的冲突是因为默认情况下ASP.NET Core的路由不会把查询参数作为同路径下HttpGet端点的匹配区分条件，直接新增同名无路由模板的[HttpGet]方法会触发路由歧义报错。以下是两种可行的实现方案：

方案1：复用现有无参Get端点，新增可选查询参数（最简洁） #

直接修改你现有的无参Get方法，添加可选的name查询参数，在方法内根据参数是否存在走不同逻辑：

[Route("api/[controller]")]
[ApiController]
public class ItemsController : ControllerBase
{
    // 原有不带参数的查询，新增可选name查询参数
    [HttpGet]
    public IActionResult Get([FromQuery] string? name = null)
    {
        // 带name查询参数的逻辑
        if (!string.IsNullOrWhiteSpace(name))
        {
            // 替换为你自己按名称查询的业务逻辑
            var targetItem = GetItemByName(name);
            return Ok(targetItem);
        }
        // 原有返回所有Items的逻辑
        return Ok(new Items());
    }

    // 原有按id查询的端点保持不变
    [HttpGet("{id:guid}")]
    public IActionResult Get(Guid id)
    {
        var item = new Item(id);
        return Ok(item);
    }
}

• 说明：给id参数加上:guid路由约束可以进一步避免路由匹配冲突，确保只有符合Guid格式的路径参数才会走到这个端点。

方案2：单独拆分按name查询的端点 #

如果你希望把按名称查询的逻辑拆成独立方法，可以给name参数加上[Required]特性，.NET 6+ 版本的路由系统会自动将必填查询参数作为匹配依据，不会和无参端点冲突：

[Route("api/[controller]")]
[ApiController]
public class ItemsController : ControllerBase
{
    // 原有返回所有Items的端点
    [HttpGet]
    public IActionResult Get()
    {
        return Ok(new Items());
    }

    // 新增带必填name查询参数的端点
    [HttpGet]
    public IActionResult GetByName([FromQuery, Required] string name)
    {
        // 替换为你自己按名称查询的业务逻辑
        var targetItem = GetItemByName(name);
        return Ok(targetItem);
    }

    // 原有按id查询的端点保持不变
    [HttpGet("{id:guid}")]
    public IActionResult Get(Guid id)
    {
        var item = new Item(id);
        return Ok(item);
    }
}

• 说明：如果是低于.NET 6的版本，需要额外自定义路由约束来实现查询参数的匹配区分，更推荐使用方案1。

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