Asp.net继承ControllerBase重写方法引发Swagger绑定错误问题

我定义了继承自ControllerBase的泛型BaseController类，其中包含标记[HttpGet]特性的虚方法Query。当用UniqueController继承BaseController，并使用new关键字重写Query方法后，出现如下错误：

Actions require an explicit HttpMethod binding for Swagger/OpenAPI 3.0

相关代码 #

BaseController

public class BaseController<T> : ControllerBase where T : BaseModel, new() 
{
        [HttpGet]
        public virtual async Task<IActionResult> Query()
        {
            var models = await _baseService.QueryModelAsync();
            return Ok(ApiResultHelper.Success("Success", new { Value = models }, models.Count));
        }
}

UniqueController

public class UniqueController<T> : BaseController<T> where T : UniqueModel, new()
{
        public new async Task<IActionResult> Query()
        {
            var models = await _modelService.QueryModelAsync();
            return Ok(ApiResultHelper.Success("Success", new { Value = models }, models.Count));
        }
}

UserController（实际使用）

public class UserController : UniqueController<UserModel>
{
        public UserController(UniqueService<UserModel> modelService, IHttpContextAccessor httpContextAccessor) 
            : base(modelService, httpContextAccessor) {}
}

解决办法 #

原因分析

使用new关键字只是隐藏了基类的Query方法，而非真正重写。基类的[HttpGet]特性不会自动应用到用new声明的同名方法上，导致Swagger无法识别该Action的HTTP方法绑定，从而抛出错误。

方案一：给新方法添加[HttpGet]特性

直接在UniqueController的Query方法上标注[HttpGet]，明确指定HTTP方法：

public class UniqueController<T> : BaseController<T> where T : UniqueModel, new()
{
        [HttpGet]
        public new async Task<IActionResult> Query()
        {
            var models = await _modelService.QueryModelAsync();
            return Ok(ApiResultHelper.Success("Success", new { Value = models }, models.Count));
        }
}

方案二：改用override关键字重写（推荐）

override是真正的方法重写，会继承基类的特性（包括[HttpGet]），同时实现自定义逻辑：

// BaseController 保持原有代码不变
public class BaseController<T> : ControllerBase where T : BaseModel, new() 
{
        [HttpGet]
        public virtual async Task<IActionResult> Query()
        {
            var models = await _baseService.QueryModelAsync();
            return Ok(ApiResultHelper.Success("Success", new { Value = models }, models.Count));
        }
}

// UniqueController 修改为 override 重写
public class UniqueController<T> : BaseController<T> where T : UniqueModel, new()
{
        public override async Task<IActionResult> Query()
        {
            var models = await _modelService.QueryModelAsync();
            return Ok(ApiResultHelper.Success("Success", new { Value = models }, models.Count));
        }
}

这种方式更符合面向对象的重写逻辑，也能避免特性丢失的问题。

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