Swagger未列出C#默认接口实现的控制器接口方法问题咨询

在ASP.NET Core中落地组合优于继承的设计原则时，尝试使用C# 8.0的接口默认实现特性，给控制器按需挂载可复用的端点逻辑：比如只给需要读能力的控制器挂载IMyReusableReadInterface<TViewModel>，只给需要写能力的控制器挂载写接口，避免继承基类控制器时被迫引入所有不需要的冗余方法。
示例实现代码如下：

public class MyController : IMyReusableReadInterface<MyViewModel>
{
    public async Task<ActionResult<MyViewModel>> MyDomainAction(...)
    {
        // 控制器自定义实现的动作
    }
}

public interface IMyReusableReadInterface<TViewModel>
{
    public async Task<ActionResult<TViewModel>> Get(...)
    {
        // 通用读逻辑默认实现
    }
}

实际运行时，控制器内自定义实现的MyDomainAction可以正常被识别、在Swagger中展示，但接口中默认实现的Get方法既无法被路由匹配，也不会出现在Swagger文档中。

ASP.NET Core默认的控制器动作发现流程由ControllerActionDescriptorProvider在应用启动阶段执行，核心逻辑如下：

• 首先按照约定筛选出所有控制器类型：包括继承自ControllerBase/Controller的类型、标记了[ApiController]特性的类型、以及满足自定义控制器判定规则的类型。
• 对每个筛选出的控制器类型，仅枚举该类型本身、以及其继承链上所有父类的公共实例方法，再按照动作规则过滤：排除构造函数、排除object类定义的基础方法、排除标记了[NonAction]特性的方法、匹配路由约定/路由特性标记的方法，最终生成有效的动作描述符集合，注册为可路由的MVC端点。
• Swagger本身是直接读取已经注册完成的动作描述符集合生成文档，不会自己额外扫描控制器方法。

这个问题和Swagger无关，本质是框架默认逻辑和C#默认接口方法的元数据特性不匹配：

• C#的接口默认实现方法不会自动作为公共成员写入实现类的类型元数据。也就是说，当你没有在控制器类中显式重写接口的默认方法时，反射遍历MyController类的公共实例方法，是拿不到这个Get方法的；只有显式在类中实现/重写该方法，它才会出现在类的成员列表中。
• 默认的动作发现逻辑从设计上就没有遍历控制器实现的所有接口、提取接口默认实现方法的逻辑，因此这些方法从一开始就不会被注册为有效端点，自然也不会出现在Swagger文档中。

你当前的思路不属于代码逻辑错误，只是使用方式不在ASP.NET Core框架的默认支持范围内，可以根据需求选择调整方向：

• 如果要坚持使用接口默认实现的写法，需要自定义IActionDescriptorProvider实现，补充对控制器实现接口的扫描逻辑，提取接口上符合动作规则的默认实现方法，手动补全路由元数据、参数绑定信息、筛选器配置后，生成对应的动作描述符加入动作集合。注意这种方式需要处理很多边缘场景，比如路由冲突、接口层级继承、模型元数据识别等问题，维护成本较高。
• 如果不想修改框架底层的动作发现逻辑，更符合框架约定的组合式实现方式是使用空标记接口配合启动时自动映射端点：比如定义IReadController<TViewModel>、IWriteController<TViewModel>这类没有方法的空接口作为能力标记，在Program.cs启动阶段遍历所有控制器类型，识别挂载了对应标记接口的控制器，直接映射通用处理逻辑到对应路由，同样可以实现按需挂载能力、不引入冗余方法的效果，稳定性更高。
• 也可以直接使用最小API的分组、复用委托逻辑实现端点的按需挂载，完全绕开控制器的动作发现逻辑，实现更轻量的组合式端点复用。

内容的提问来源于stack exchange，提问作者Rogier van het Schip