REST API如何实现按ID/名称查询用户的同名接口且符合规范？

可行的REST友好方案 #

方案1：统一使用查询参数 #

保持单个GET /api/User接口，通过查询参数区分查询条件：

• 通过ID查询：GET /api/User?id=123
• 通过名称查询：GET /api/User?name=张三

后端只需一个方法处理，根据传入的查询参数分支逻辑：

[HttpGet]
public async Task<IActionResult> Get([FromQuery] int? id, [FromQuery] string name)
{
    if (id.HasValue)
    {
        // 根据ID查询用户逻辑
        return Ok(await _userService.GetById(id.Value));
    }
    else if (!string.IsNullOrEmpty(name))
    {
        // 根据名称查询用户逻辑
        return Ok(await _userService.GetByName(name));
    }
    // 处理参数缺失的情况，比如返回400或所有用户列表
    return BadRequest("请提供id或name查询参数");
}

方案2：路径参数+查询参数结合 #

保留原有的GET /api/User/{id:int}作为单用户精准获取接口，同时新增查询参数方式的名称查询接口：

// 通过ID获取单个用户（原接口）
[HttpGet("{id:int}")]
public async Task<IActionResult> GetById(int id)
{
    var user = await _userService.GetById(id);
    if (user == null) return NotFound();
    return Ok(user);
}

// 通过名称查询用户
[HttpGet]
public async Task<IActionResult> GetByName([FromQuery] string name)
{
    if (string.IsNullOrEmpty(name)) return BadRequest("name参数不能为空");
    var users = await _userService.GetByName(name);
    return Ok(users);
}

这种设计更贴合REST语义：路径参数{id}对应单个资源的精准获取，查询参数对应资源的筛选查询，既不违反REST规则，也彻底避免了路由冲突。

修复你的代码问题 #

你当前代码出现两个异常的核心原因是：两个[HttpGet]修饰的方法没有设置差异化路由，导致它们的请求路径完全一致（都是GET /api/WeatherForecast），Swagger无法生成唯一的接口文档，运行时路由匹配也会因歧义报错。按照上面的方案修改代码，确保每个HttpGet方法的「请求方法+路径」组合唯一，就能解决这两个问题。

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