ASP.NET Core 6中[ApiController]导致POST参数为空的问题咨询

问题诊断 #

你遇到的参数绑定问题，主要由三个原因导致：

1. Postman请求JSON语法错误：Payload中"CompCode": "Test Comp"末尾缺少逗号，导致JSON解析失败，直接引发参数绑定为空。
2. 控制器返回属性名错误：方法中返回BillRequest时使用了不存在的CompanyCode属性，应该对应模型中的CompCode，这会导致返回结果不符合预期，容易误导问题判断。
3. [ApiController]的参数绑定规则差异：带该特性的控制器，参数绑定逻辑和普通控制器完全不同，复杂类型默认不会从请求体读取，必须显式声明绑定源。

解决方案 #

1. 修复Postman的JSON语法 #

修正后的Payload：

{
    "CompCode": "Test Comp",
    "CustNo": "1235",
    "ID": "123123123",
    "Type": "01",
    "TransDate": "Test Date",
    "Remark": "My Remark"
}

2. 显式指定参数绑定源 #

在控制器方法的参数上添加[FromBody]特性，明确告诉框架从请求体读取JSON：

[HttpPost]
[Route("[Action]")]
public BillRequest Bills([FromBody] BillRequest billReq)
{
    // ... 原有逻辑
}

3. 修复返回属性名错误 #

将返回对象中的CompanyCode改为模型中存在的CompCode：

if (ModelState.IsValid)
{
    return new BillRequest
    {
        CompCode = "Test - success"
    };
}
else
{
    return new BillRequest()
    {
        CompCode = "Test - not valid model"
    };
}

[ApiController]特性的具体影响 #

和普通控制器相比，添加[ApiController]后会启用一系列API专属的行为，核心差异包括：

• 参数绑定规则变更：
  • 普通控制器：复杂类型参数会自动尝试从多个源（请求体、表单、查询字符串）绑定，优先级由配置决定。
  • 带[ApiController]的控制器：启用推断绑定源逻辑，复杂类型默认不从请求体绑定，必须显式加[FromBody]；简单类型（如string、int）默认从查询字符串绑定，若要从请求体读取也需要手动指定[FromBody]。
• 自动模型验证：当ModelState无效时，框架会自动返回400 Bad Request响应，无需手动判断ModelState.IsValid（你代码中的手动判断依然有效，但可以简化）。
• 强制属性路由：要求控制器必须使用属性路由（如[Route]），不能使用传统的基于约定的路由。
• 自动错误处理：自动处理常见的API错误场景，比如JSON解析失败、参数缺失等，直接返回标准的HTTP错误响应。

之所以移除[ApiController]后参数能正常绑定，是因为普通控制器的绑定逻辑会默认尝试从请求体读取JSON，无需显式声明，但这种行为不符合REST API的规范（复杂参数应该明确从请求体传递），建议保留[ApiController]并按规范添加[FromBody]特性。

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