.NET Core 添加全局响应过滤器后控制器默认200返回类型丢失如何解决

问题根因 #

你直接在MvcOptions的全局过滤器中添加ProducesResponseTypeAttribute时，会触发框架的手动指定响应逻辑，不再自动推导控制器方法的默认200状态码返回类型，因此Swagger中只会展示你手动添加的错误响应。

解决方案 #

推荐以下两种实现方式，按需选择即可：

方案1：使用IActionModelConvention追加响应（API元数据层面生效） #

该方案会在每个API Action的现有元数据基础上追加错误响应，不会覆盖原有的自动推导逻辑：

1. 自定义约定类

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.ApplicationModels;
using System.Net;

public class ErrorResponseConvention : IActionModelConvention
{
    public void Apply(ActionModel action)
    {
        // 仅对API控制器生效，可根据业务需求调整过滤条件
        if (!action.Controller.Attributes.Any(attr => attr is ApiControllerAttribute))
            return;
        
        // 追加错误响应，不会覆盖原有自动生成的200响应
        action.Filters.Add(new ProducesResponseTypeAttribute(typeof(ErrorResponse), (int)HttpStatusCode.BadRequest));
        action.Filters.Add(new ProducesResponseTypeAttribute(typeof(ErrorResponse), (int)HttpStatusCode.Unauthorized));
        action.Filters.Add(new ProducesResponseTypeAttribute(typeof(ErrorResponse), (int)HttpStatusCode.NotFound));
        action.Filters.Add(new ProducesResponseTypeAttribute(typeof(ErrorResponse), (int)HttpStatusCode.InternalServerError));
    }
}

2. 替换原有Mvc配置
   删掉原来AddMvc中添加的四个ProducesResponseTypeAttribute，改为注册自定义约定：

services.AddMvc(options =>
{
    options.EnableEndpointRouting = false;
    options.Conventions.Add(new ErrorResponseConvention());
});

方案2：使用Swagger OperationFilter追加响应（仅Swagger层面生效） #

如果你只需要Swagger展示错误响应，不需要影响API运行逻辑，可以直接在Swagger生成环节追加：

1. 自定义操作过滤器

using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;
using System.Net;

public class ErrorResponseOperationFilter : IOperationFilter
{
    public void Apply(OpenApiOperation operation, OperationFilterContext context)
    {
        // 生成ErrorResponse的统一Schema
        var errorSchema = context.SchemaGenerator.GenerateSchema(typeof(ErrorResponse), context.SchemaRepository);
        
        var errorStatusCodes = new List<HttpStatusCode>
        {
            HttpStatusCode.BadRequest,
            HttpStatusCode.Unauthorized,
            HttpStatusCode.NotFound,
            HttpStatusCode.InternalServerError
        };
        // 追加不存在的错误响应
        foreach (var statusCode in errorStatusCodes)
        {
            var code = ((int)statusCode).ToString();
            if (!operation.Responses.ContainsKey(code))
            {
                operation.Responses.Add(code, new OpenApiResponse
                {
                    Description = statusCode.ToString(),
                    Content = new Dictionary<string, OpenApiMediaType>
                    {
                        ["application/json"] = new OpenApiMediaType { Schema = errorSchema }
                    }
                });
            }
        }
    }
}

2. 注册过滤器到Swagger配置

services.AddSwaggerGen(opt =>
{
    // 保留你原有的Swagger配置
    opt.OperationFilter<ErrorResponseOperationFilter>();
});

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