.NET Core 3.1配置HTTPS时如何返回状态码描述？

问题根源在于：当使用HTTPS时，Kestrel默认启用HTTP/2协议，而HTTP/2规范中不要求传输状态码描述（Reason Phrase）；而HTTP请求默认使用HTTP/1.1，该协议会返回状态码对应的描述文本。

以下是三种可行的解决方案：

1. 强制HTTPS端点使用HTTP/1.1 #

通过配置Kestrel，让HTTPS端口强制使用HTTP/1.1协议，这样响应会自动包含状态码描述：

在Startup.cs的ConfigureServices方法中添加Kestrel配置：

public void ConfigureServices(IServiceCollection services)
{
    // 其他服务配置...
    
    services.Configure<KestrelServerOptions>(options =>
    {
        // 配置HTTPS端口（示例为5001）
        options.ListenAnyIP(5001, listenOptions =>
        {
            listenOptions.UseHttps(); // 开发环境可使用默认证书，生产环境需指定证书路径
            listenOptions.Protocols = HttpProtocols.Http1; // 强制使用HTTP/1.1
        });
        
        // 可选：配置HTTP端口（示例为5000）
        options.ListenAnyIP(5000, listenOptions =>
        {
            listenOptions.Protocols = HttpProtocols.Http1;
        });
    });
    
    services.AddControllers();
    // Swagger等其他配置...
}

或者在Program.cs的主机配置中直接设置：

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>()
                .ConfigureKestrel(options =>
                {
                    options.ListenAnyIP(5001, listenOptions =>
                    {
                        listenOptions.UseHttps();
                        listenOptions.Protocols = HttpProtocols.Http1;
                    });
                });
        });

2. 通过中间件手动添加状态码描述 #

如果需要保留HTTP/2支持，可添加自定义中间件，在响应发送前为状态码补充描述文本：

在Startup.cs的Configure方法中，将以下中间件放在最前面（UseHttpsRedirection之前）：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // 自定义状态码描述中间件
    app.Use(async (context, next) =>
    {
        await next();
        
        // 根据状态码获取对应的描述文本
        var statusCode = context.Response.StatusCode;
        var reasonPhrase = Microsoft.AspNetCore.WebUtilities.ReasonPhrases.GetReasonPhrase(statusCode);
        
        if (!string.IsNullOrEmpty(reasonPhrase))
        {
            // 设置响应的Reason Phrase
            context.Response.HttpContext.Features.Get<IHttpResponseFeature>().ReasonPhrase = reasonPhrase;
        }
    });

    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    app.UseSwagger();
    app.UseSwaggerUI(options =>
    {
        options.SwaggerEndpoint("/swagger/v1/swagger.json", "BAIM");
    });
    app.UseHttpsRedirection();
    app.UseRouting();
    app.UseAuthentication();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

注意：HTTP/2协议本身不传输Reason Phrase，因此使用HTTP/2的客户端可能仍无法看到描述，但HTTP/1.1客户端访问HTTPS端点时会正常显示。

3. 在控制器中显式返回带描述的响应 #

如果仅需特定接口返回状态码描述，可在控制器方法中直接返回包含描述的响应体：

[HttpGet]
public ActionResult<IEnumerable<WeatherForecast>> Get()
{
    // 方式1：直接返回带描述的BadRequest
    return BadRequest("Bad Request");
    
    // 方式2：使用规范的ProblemDetails（推荐）
    // var problemDetails = new ProblemDetails
    // {
    //     Status = StatusCodes.Status400BadRequest,
    //     Title = "Bad Request",
    //     Detail = "请求格式无效，服务器无法解析"
    // };
    // return new ObjectResult(problemDetails) { StatusCode = StatusCodes.Status400BadRequest };
}

这种方式不受HTTP协议版本影响，响应体中会明确包含状态码及对应描述信息。

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