.NET中Swagger生成API客户端无法传递列表参数的问题咨询

我之前也碰到过完全一样的坑，给你几个亲测有效的解决方案：

方案1：调整Swagger的Schema生成配置 #

有时候Swagger默认不会把List<T>正确识别为数组类型，导致生成客户端时变成单个对象。你可以在Swagger的配置里强制让它把所有集合都当成数组处理：

// 在Program.cs或Startup.cs的Swagger配置中添加
services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "你的API名称", Version = "v1" });
    
    // 关键配置：强制将所有集合类型识别为数组
    c.SchemaGeneratorOptions.TreatAllCollectionsAsArray = true;
});

配置完之后，重启服务，先去Swagger UI里看接口的请求体是不是已经变成array类型了。如果是的话，再重新生成客户端，应该就能得到接收IList<Plan>的方法了。

方案2：用DTO包装列表参数 #

如果调整Swagger配置没用，或者你更倾向于规范的API设计，建议把列表参数包装到一个DTO类里。这种方式兼容性最好，几乎不会有工具识别问题：

首先定义一个DTO类：

public class PlanBatchRequest
{
    public List<Plan> Plans { get; set; } = new List<Plan>();
}

然后修改你的控制器方法：

[HttpPost]
[Route("Plan")]
public IActionResult PostPlan([FromBody]PlanBatchRequest request) 
{ 
    // 在这里使用request.Plans获取传入的列表
    // ...你的业务逻辑
}

重新生成客户端后，生成的方法就会接收PlanBatchRequest类型的参数，你只需要把要传递的Plan列表赋值给它的Plans属性即可。

方案3：检查客户端生成工具的配置 #

如果你用的是NSwag、Swagger Codegen这类工具生成客户端，还要检查工具本身的配置：

• NSwag：在生成配置的「Operation Generation」部分，确保「Collection type」设置为System.Collections.Generic.List，同时确认「Wrap complex parameters」的选项没有错误地把列表拆成单个参数。
• Swagger Codegen：在生成命令中添加--collection-type List参数，强制生成List类型的集合参数。

另外，先确认Swagger UI里的接口文档是否正确显示请求体为数组类型。如果Swagger文档本身就显示的是单个Plan对象，那生成的客户端肯定有问题，优先解决Swagger文档的识别问题。

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