将DateTimeOffset传递至Web API时遇到参数发送问题

我之前也踩过DateTimeOffset在前后端传递的坑，结合你的代码情况，给你几个实用的解决方案：

1. 确保前端传递的日期格式符合要求 #

JSON.stringify默认会把JavaScript的Date对象转成ISO 8601格式的字符串（比如"2024-05-20T14:30:00.000Z"），但Web API对DateTimeOffset的解析需要明确的时区偏移信息。如果你的前端日期没有正确带偏移，后端就无法解析成DateTimeOffset类型。

你可以手动把日期转成带偏移的标准格式：

// 示例：将Date对象转为带时区偏移的ISO字符串
this.sprintReview.PlannedStart = new Date().toISOString();
// 如果用dayjs/moment这类库，能更灵活控制格式：
// this.sprintReview.PlannedStart = dayjs().format('YYYY-MM-DDTHH:mm:ssZZ');

2. 调整后端的JSON序列化配置 #

如果前端格式没问题，但后端还是解析失败，可能是默认的JSON序列化器对DateTimeOffset的解析规则太严格。你可以在后端的配置里放宽解析规则：

如果你用的是System.Text.Json（.NET Core 3.0+默认） #

在Program.cs/Startup.cs里添加配置：

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        // 允许不区分大小写解析属性
        options.JsonSerializerOptions.PropertyNameCaseInsensitive = true;
        // 添加自定义DateTimeOffset转换器，支持更多格式
        options.JsonSerializerOptions.Converters.Add(new JsonConverter<DateTimeOffset?>(
            (writer, value, options) => 
                writer.WriteString(value?.ToString("o")),
            (reader, type, options) => 
                DateTimeOffset.TryParse(reader.GetString(), out var result) ? result : null
        ));
    });

如果你用的是Newtonsoft.Json（Json.NET） #

如果项目引用了Newtonsoft，可以这样配置：

builder.Services.AddControllers()
    .AddNewtonsoftJson(options =>
    {
        // 保留时区信息进行序列化/反序列化
        options.SerializerSettings.DateTimeZoneHandling = DateTimeZoneHandling.RoundtripKind;
        // 优先解析为DateTimeOffset
        options.SerializerSettings.DateParseHandling = DateParseHandling.DateTimeOffset;
    });

3. 确认请求的Content-Type设置 #

前端发送请求时，一定要确保请求头里的Content-Type是application/json，否则后端可能不会按JSON格式解析请求体。检查你的baseService.post方法是否正确设置了请求头：

// 在baseService的post方法中添加headers配置
post(url: string, body: string) {
    const headers = new HttpHeaders({
        'Content-Type': 'application/json'
    });
    return this.http.post(url, body, { headers });
}

4. 排查参数名称大小写问题 #

前端TypeScript里的属性名（比如PlannedStart）要和后端模型的属性名一致，或者确保后端配置了不区分大小写解析（上面第2点里的PropertyNameCaseInsensitive = true就是干这个的），避免因为大小写不匹配导致参数无法绑定。

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