WebClient向POST接口传空请求体及[FromBody]参数选型最佳实践

1. 规范传递空请求体的最佳实践 #

首先需要先调整服务端接口配置，再统一客户端调用规范，符合HTTP和RESTful行业标准：

服务端适配（必做，否则空请求体会返回400错误） #

ASP.NET Core默认要求[FromBody]修饰的参数必须有有效值，空请求体直接调用会触发模型绑定校验失败，需要先做两处配置：

1. 在服务启动配置中开启空请求体绑定允许：

// Program.cs 示例（.NET 6+ 顶层语句）
builder.Services.AddControllers(options =>
{
    // 允许请求体为空时正常绑定参数
    options.AllowEmptyInputInBodyModelBinding = true;
});

2. 将接口的请求体参数声明为可空类型：

[HttpPost("process")]
// 加?表示参数可为null
public IActionResult Process (string Val1, [FromBody] object? Json)
{
    // 先做判空处理，再执行业务逻辑
    if (Json == null) 
    {
        // 无请求体的处理逻辑
    }
    return Ok();
}

客户端调用规范（跨客户端通用兼容方案） #

有两种符合标准的实现，优先推荐第一种，兼容性最高，适配所有语言的HTTP客户端：

• 传递空JSON对象{}作为请求体，也就是你当前在用的方案，所有HTTP客户端都不会出现序列化/请求格式错误，不会触发各网关、反向代理的格式校验拦截
• 传递空字符串作为请求体，同时设置Content-Length: 0请求头，符合HTTP空请求体的标准规范，但部分老旧客户端可能对空请求体+application/json的组合处理有兼容问题

2. 请求体参数选型建议 #

object类型的缺点是运行时类型转换麻烦，没有语法提示，很容易出现运行时错误，更优的选型分两种场景：

场景1：请求体结构不固定，需要动态处理字段 #

• 如果你的项目用Newtonsoft.Json作为JSON序列化组件，换成JObject?完全符合需求，兼容空请求体场景：空请求体绑定为null，{}绑定为无字段的空JObject实例，可以直接用索引、GetValue等方法读取字段，比object方便很多
• 如果你的项目用ASP.NET Core默认的System.Text.Json作为序列化组件，推荐换成JsonElement?类型，和JObject用法类似，不需要额外引入第三方包

场景2：请求体结构固定/半固定 #

最优方案是定义强类型DTO作为参数类型，示例：

// 定义请求体结构
public class ProcessRequestDto
{
    // 所有可选字段都声明为可空类型
    public string? Field1 { get; set; }
    public int? Field2 { get; set; }
}

// 接口参数换成强类型DTO
[HttpPost("process")]
public IActionResult Process (string Val1, [FromBody] ProcessRequestDto? Json)
{
    // 模型绑定会自动转换，开发时有强类型提示，避免运行时类型错误
    return Ok();
}

强类型方案的可维护性、接口可阅读性远高于动态类型，还能直接用ASP.NET Core自带的模型校验功能，是API开发的首选方案。

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