ASP.NET Core Web API控制器两个HttpGet方法致Swagger加载失败的解决问询

在ASP.NET Core Web API控制器中，若要实现两个独立的HttpGet Action：一个通过查询参数ID获取单个实体，另一个获取所有实体，且不想合并方法、也不想修改基础路由，可通过以下方案解决路由匹配及Swagger加载问题：

方案1：使用查询参数约束（QueryStringConstraint） #

通过QueryStringConstraint明确指定每个Action匹配的查询参数存在条件，让ASP.NET Core能精准区分两个请求。

首先引用Microsoft.AspNetCore.Mvc.ActionConstraints命名空间，再修改控制器代码：

using Microsoft.AspNetCore.Mvc.ActionConstraints;

[ApiController]
[Route("api/[controller]")]
public class EntitiesController : ControllerBase
{
    private readonly IRepository<cfEntity> repository;

    public EntitiesController(IRepository<cfEntity> repository)
    {
        this.repository = repository;
    }

    // 匹配包含id查询参数的请求
    [HttpGet]
    [QueryStringConstraint("id", true)]
    public async Task<cfEntity> GetById([FromQuery] Guid id)
    {
        return await repository.GetAsync(id);
    }

    // 匹配不包含id查询参数的请求
    [HttpGet]
    [QueryStringConstraint("id", false)]
    public async Task<IEnumerable<cfEntity>> Get()
    {
        return await repository.GetAsync();
    }
}

此方式保持两个Action使用同一基础路由，ASP.NET Core会根据请求是否携带id参数自动路由到对应方法。

方案2：使用必填参数约束（[Required]） #

给GetById方法的id参数添加[Required]特性，当请求未携带id查询参数时，模型验证不通过，ASP.NET Core会自动匹配到无必填参数的Get方法。

引用System.ComponentModel.DataAnnotations命名空间后修改代码：

using System.ComponentModel.DataAnnotations;

[ApiController]
[Route("api/[controller]")]
public class EntitiesController : ControllerBase
{
    private readonly IRepository<cfEntity> repository;

    public EntitiesController(IRepository<cfEntity> repository)
    {
        this.repository = repository;
    }

    // 仅匹配携带必填id查询参数的请求
    [HttpGet]
    public async Task<IActionResult> GetById([FromQuery, Required] Guid id)
    {
        var entity = await repository.GetAsync(id);
        if (entity == null) return NotFound();
        return Ok(entity);
    }

    // 匹配未携带id参数的请求
    [HttpGet]
    public async Task<IEnumerable<cfEntity>> Get()
    {
        return await repository.GetAsync();
    }
}

注：若请求携带格式无效的id（如非Guid字符串），会返回400错误，符合RESTful API的参数验证规范。

可选：调整Swagger配置 #

若上述方案后Swagger仍显示冲突，可给每个Action指定唯一的OperationId，确保Swagger能正确识别：

// 在GetById方法上添加
[SwaggerOperation(OperationId = "GetEntityById")]

// 在Get方法上添加
[SwaggerOperation(OperationId = "GetAllEntities")]

需提前引用Swashbuckle.AspNetCore.SwaggerGen包。

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