.NET 8 Web API中WriteAsJsonAsync与RFC 9457合规性问题咨询

问题背景 #

在.NET 8 Web API中使用IExceptionHandler实现全局异常处理时，发现调用WriteAsJsonAsync方法会自动将响应的Content-Type设置为application/json; charset=utf-8，但根据RFC 9457标准，错误响应应该使用application/problem+json类型，当前写法中提前设置的Content-Type会被WriteAsJsonAsync覆盖，导致不符合标准要求。

解决方案 #

以下两种可行方式，都能保证响应的Content-Type符合RFC 9457规范：

方案1：手动序列化并写入响应流 #

绕过WriteAsJsonAsync的自动Content-Type设置逻辑，直接使用JsonSerializer序列化异常详情后写入响应流，完全可控不会覆盖已设置的Content-Type。

修改后的代码片段：

var response = httpContext.Response;
if (!response.HasStarted)
{
    response.StatusCode = errorResult.Status!.Value;
    response.ContentType = "application/problem+json";
    // 保持和WriteAsJsonAsync一致的驼峰命名序列化规则
    var jsonOptions = new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase };
    var jsonString = JsonSerializer.Serialize(errorResult, jsonOptions);
    await response.WriteAsync(jsonString, Encoding.UTF8, cancellationToken).ConfigureAwait(false);
}

方案2：使用WriteAsJsonAsync的重载指定MediaType #

WriteAsJsonAsync提供了支持指定MediaType的重载，直接传入application/problem+json即可让框架自动设置正确的Content-Type，无需手动设置后被覆盖。

修改后的代码片段：

var response = httpContext.Response;
if (!response.HasStarted)
{
    response.StatusCode = errorResult.Status!.Value;
    // 直接在方法中指定符合标准的MediaType
    await response.WriteAsJsonAsync(
        errorResult,
        mediaType: "application/problem+json",
        cancellationToken: cancellationToken
    ).ConfigureAwait(false);
}

补充说明 #

• 方案2更简洁，复用了框架内置的序列化逻辑，推荐优先使用。
• 确保你的ExceptionDetails类结构符合RFC 9457要求（包含type、title、status、detail、instance等核心字段），才能完全适配标准的问题详情响应格式。

内容的提问来源于stack exchange，提问作者santosh kumar patro