ASP.NET Core 6 Web API：如何区分不同HttpGet动作的路由？

你遇到的错误是因为三个HttpGet动作都映射到了同一个GET api/Order路径，而Swagger/OpenAPI 3.0要求每个HTTP方法与路径的组合必须唯一，所以触发了冲突提示。下面是几种可行的解决方式：

方式一：给每个动作设置差异化的路由模板 #

通过为不同查询逻辑指定不同的路由片段，让每个HttpGet的路径唯一：

[Route("api/[controller]")]
[ApiController]
public class OrderController : ControllerBase
{
    private readonly IMediator _mediator;

    public OrderController(IMediator mediator)
    {
        _mediator = mediator;
    }

    // 获取所有订单：路径为 GET api/Order
    [HttpGet("", Name = "GetAllOrders")]
    public async Task<ActionResult<IEnumerable<OrderVm>>> GetAllOrders()
    {
        var query = new AllOrdersQuery();
        var orders = await _mediator.Send(query);
        return orders;
    }

    // 按用户名查询：路径为 GET api/Order/by-username?username=xxx 
    [HttpGet("by-username", Name = "GetOrdersByUsername")]
    public async Task<ActionResult<IEnumerable<OrderVm>>> GetOrdersByUsername([FromQuery] string username)
    {
        var query = new OrdersByUsernameQuery(username);
        var orders = await _mediator.Send(query);
        return orders;
    }

    // 按ID查询：路径为 GET api/Order/{id}
    [HttpGet("{id:int}", Name = "GetOrderById")]
    public async Task<ActionResult<OrderVm>> GetOrderById(int id)
    {
        var query = new OrderByIdQuery(id);
        var order = await _mediator.Send(query);
        return order;
    }
}

方式二：合并相似逻辑为单个动作 #

如果想保留同一个基础路径，可以将“获取所有订单”和“按用户名查询”的逻辑合并到一个方法中，通过可选参数区分：

[Route("api/[controller]")]
[ApiController]
public class OrderController : ControllerBase
{
    private readonly IMediator _mediator;

    public OrderController(IMediator mediator)
    {
        _mediator = mediator;
    }

    // 统一处理：无参数时获取所有，有username参数时按用户名查询
    [HttpGet("", Name = "GetOrders")]
    public async Task<ActionResult<IEnumerable<OrderVm>>> GetOrders(string username = null)
    {
        if (string.IsNullOrWhiteSpace(username))
        {
            var query = new AllOrdersQuery();
            return await _mediator.Send(query);
        }
        else
        {
            var query = new OrdersByUsernameQuery(username);
            return await _mediator.Send(query);
        }
    }

    // 按ID查询单独设置路由
    [HttpGet("{id:int}", Name = "GetOrderById")]
    public async Task<ActionResult<OrderVm>> GetOrderById(int id)
    {
        var query = new OrderByIdQuery(id);
        var order = await _mediator.Send(query);
        return order;
    }
}

关键说明 #

• 路由冲突的核心原因是相同HTTP方法+相同路径对应了多个动作，只要让其中一个维度不同即可解决
• 推荐使用方式一，因为它的语义更清晰，符合RESTful API的设计规范，也便于Swagger生成清晰的接口文档

内容的提问来源于stack exchange，提问作者Tech with Thiru