如何在.NET ApiController的204 NoContent响应中返回ProblemDetails？

首先得明确核心点：HTTP 204 NoContent的标准语义就是响应不能包含任何主体，ASP.NET Core严格遵循这个规范，所以哪怕你试图给204响应附加ProblemDetails，框架也会自动清空响应体——这就是你配置AddProblemDetails和ProblemDetailsFactory无效的根本原因。

下面给你两个可行方向，优先推荐符合HTTP规范的方案：

方案一：改用符合业务语义的状态码（推荐） #

如果业务上需要在无数据时返回详细说明，建议放弃204，改用以下状态码之一：

• 200 OK：适合无数据但属于正常业务场景的情况，返回包含ProblemDetails的响应或空列表
• 404 Not Found：如果"无数据"意味着请求的资源不存在（比如指定的dashboardId没有对应数据）

修改你的控制器代码示例：

// 替换原有的return NoContent()
return Ok(new ProblemDetails
{
    Type = "https://example.com/problems/no-data-available",
    Title = "无可用数据",
    Status = StatusCodes.Status200OK,
    Detail = $"dashboardId {dashboardId} 未查询到任何重要数据",
    Instance = HttpContext.Request.Path
});

// 或者用404（如果业务上属于资源不存在场景）
return NotFound(new ProblemDetails
{
    Type = "https://example.com/problems/dashboard-data-not-found",
    Title = "数据不存在",
    Status = StatusCodes.Status404NotFound,
    Detail = $"未找到与dashboardId {dashboardId} 匹配的重要数据",
    Instance = HttpContext.Request.Path
});

同时更新ProducesResponseType注解：

// 替换原204的注解
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status200OK)]
// 或者
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]

方案二：强行绕开204的响应体限制（不推荐，违反HTTP规范） #

如果业务上必须使用204状态码且返回响应体，你需要自定义ActionResult绕过ASP.NET Core的默认处理逻辑：

自定义NoContentWithProblemDetailsResult #

public class NoContentWithProblemDetailsResult : ActionResult
{
    private readonly ProblemDetails _problemDetails;

    public NoContentWithProblemDetailsResult(ProblemDetails problemDetails)
    {
        _problemDetails = problemDetails;
        _problemDetails.Status = StatusCodes.Status204NoContent;
    }

    public override async Task ExecuteResultAsync(ActionContext context)
    {
        var httpContext = context.HttpContext;
        httpContext.Response.StatusCode = StatusCodes.Status204NoContent;
        httpContext.Response.ContentType = "application/json";

        // 注意：此操作违反HTTP 204规范，部分严格遵循规范的客户端会忽略响应体
        await httpContext.Response.WriteAsJsonAsync(_problemDetails);
    }
}

在控制器中使用 #

// 替换原return NoContent()
return new NoContentWithProblemDetailsResult(new ProblemDetails
{
    Type = "https://example.com/problems/no-data-available",
    Title = "无可用数据",
    Detail = $"dashboardId {dashboardId} 未查询到任何重要数据",
    Instance = HttpContext.Request.Path
});

注意事项 #

• 这种做法违反HTTP标准，部分客户端会忽略204响应的主体内容，导致ProblemDetails无法被正确解析
• 仅适合特殊临时场景，不要作为核心业务逻辑依赖

为什么之前的配置无效？ #

AddProblemDetails中间件默认只处理状态码>=400的响应，即便你通过options.IncludeStatusCodes添加204，ASP.NET Core处理NoContentResult时仍会强制清空响应体——这是框架对HTTP规范的实现，无法通过配置ProblemDetailsFactory绕过。

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