.NET Core中Swashbuckle无法正确处理IDictionary参数的问题求助

我之前也遇到过类似的Swashbuckle旧版本配合字典参数的问题，结合你的描述，给你几个针对性的解决方案：

1. 优先升级Swashbuckle.AspNetCore版本 #

你当前使用的1.1.0是非常早期的版本，这个版本在字典类型的Schema生成、参数绑定上存在不少已知bug，其中就包括重复键丢失、ModelState不稳定的问题，而且这些bug在后续版本中已经被修复。

建议你升级到与你的.NET Core版本兼容的稳定版：

• 如果你用的是.NET Core 2.x，推荐升级到Swashbuckle.AspNetCore 4.0.1（适配性较好）
• 如果你用的是更高版本的.NET Core（3.1+），可以直接升级到最新的稳定版

升级命令（用dotnet CLI）：

dotnet add package Swashbuckle.AspNetCore --version <对应版本号>

升级后重新测试接口，大部分问题应该能直接解决。

2. 调整参数类型以处理重复键问题 #

字典（IDictionary<string, string>）本身的特性就是不允许重复键，默认的JSON序列化器（Newtonsoft.Json）遇到重复键时会自动保留最后一个值，这是设计行为而非bug。如果你的业务场景需要接收重复键的输入，建议把参数类型换成List<KeyValuePair<string, string>>，这样可以完整接收所有键值对，再在控制器内部按需处理：

修改控制器方法签名：

[HttpPost("CalculateCost", Name = "CalculateCost")]
public IActionResult getJourneyCalculation([FromBody] List<KeyValuePair<string, string>> locations)
{
    // 处理重复键：比如保留第一个出现的键值对
    var locationDict = locations
        .GroupBy(kv => kv.Key)
        .ToDictionary(g => g.Key, g => g.First().Value);
    
    // 后续业务逻辑
    return Ok(locationDict);
}

这种方式不仅能解决重复键丢失的问题，Swashbuckle对KeyValuePair列表的Schema生成支持也更稳定，能避免ModelState波动的问题。

3. 配置JSON序列化规则（针对旧版本） #

如果暂时无法升级Swashbuckle版本，可以调整Newtonsoft.Json的序列化配置，明确处理重复键的行为，同时优化字典绑定的稳定性：

在ConfigureServices中添加：

services.AddMvc()
    .AddJsonOptions(options =>
    {
        // 遇到重复键时抛出异常，方便排查客户端的非法请求
        options.SerializerSettings.DuplicatePropertyNameHandling = DuplicatePropertyNameHandling.Error;
        // 确保字典类型能被正确反序列化
        options.SerializerSettings.ContractResolver = new DefaultContractResolver();
    });

同时，在控制器中添加ModelState校验，方便定位绑定失败的具体原因：

[HttpPost("CalculateCost", Name = "CalculateCost")]
public IActionResult getJourneyCalculation([FromBody] IDictionary<string, string> locations)
{
    if (!ModelState.IsValid)
    {
        // 返回详细的验证错误信息
        return BadRequest(ModelState);
    }
    
    // 后续业务逻辑
}

4. 自定义Swagger Schema生成（针对旧版本） #

如果升级后字典的Schema仍有问题，可以手动指定Swagger对字典类型的Schema定义：

在AddSwaggerGen配置中添加：

services.AddSwaggerGen(c => {
    c.SwaggerDoc("v1", new Info {
        Title = "Meetings Calculator API",
        Version = "v1",
        Description = "An API to provide pricing information related to journeys",
    });

    // 手动映射IDictionary<string, string>的Schema
    c.MapType<IDictionary<string, string>>(() => new Schema
    {
        Type = "object",
        AdditionalProperties = new Schema { Type = "string" }
    });
});

这个配置能确保Swagger生成正确的请求体Schema，避免客户端传入不符合要求的格式。

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