如何通过URL将一个对象列表传递给ASP.NET Web API，以便查询数据库表？

Question

我尝试通过以下方式传递对象列表，每个对象包含三个参数：变量名、操作符和值。

public async Task GetAPIData([FromQuery] Condition[] conditions)

其中 Condition 类定义如下：

public class Condition
{
    public string variable { get; set; }
    public string op { get; set; }
    public double value { get; set; }
}

但我无法成功传递这些项目，每次调用API时，“conditions”都是空的。

生成的URL虽然有些杂乱，但Swagger提供了这样的示例：

http://localhost:5001/api/datatable?conditions=%7B%22variable%22%3A%22vara%22%2C%22op%22%3A%22%3E%22%2C%22value%22%3A20%7D&conditions=%7B%22variable%22%3A%22varb%22%2C%22op%22%3A%22%3E%22%2C%22value%22%3A10%7D

在我的代码中，我尝试遍历 conditions，根据每个条件动态构建查询，但因为 conditions 是空的，所以 filteredData 最终返回的是未经筛选的整个数据集。

var t = conditions.Length;
IQueryable query = _context.datatable;

// 遍历条件并应用到查询中...

var filteredData = await query.Where(data => data.Data != null)
                              .Select(data => data.Id)
                              .ToListAsync();

问题在于，尽管我按照预期构造了URL和方法签名，conditions 参数在API调用时始终为空，导致无法正确执行过滤逻辑。

Robert Rossney · Answer

首先，我建议不要使用[FromQuery]方式传递这类数据，但如果坚持要这么做，可以参考以下代码从C#中以fromquery形式传递数组。

List conditions = new List
{
    new Condition {
        Variable = "Variable1",
        Op = ">",
        Value = 10.5
    },
    new Condition {
        Variable = "Variable2",
        Op = "<",
        Value = 20.0
    }
    // 根据需要添加更多条件
};

string apiUrl = "http://localhost:5001/api/datatable";

string queryString = string.Join("&", conditions.Select(c =>
    $"conditions={Uri.EscapeDataString(c.Variable)}:{Uri.EscapeDataString(c.Op)}{c.Value}"));

string fullUrl = $"{apiUrl}?{queryString}";

然后，在Postman中你可以这样调用这个API：

http://localhost:5001/api/datatable?conditions=Variable1:>:10.5&conditions=Variable2:<:20.0

Adam Dymitruk · Answer

看起来Swagger目前无法为这种情况生成正确的查询字符串。正确的查询字符串形式应该是这样的 ?conditions[0].variable=variable1&conditions[0].op=someOperator&conditions[0].value=10.5&conditions[1]...，并且你持续添加这种模式，每增加一个条件就将索引计数器加一。

正如你所见到的，查询字符串中的名称conditions不太美观。我建议你将动作签名改为：

public async Task GetAPIData([FromQuery(Name = "cnd")] Condition[] conditions)

这样，你就可以使用cnd[]而非conditions[]，它更短且为单数形式，使得URL看起来更加简洁。