ASP Web Api 2 GET 中的复杂参数

Question

我需要将复杂对象的列表传递给 GET 请求，以便我可以过滤结果。

复杂的对象是这样的：

public class RecordFilter
{
    public int PageNumber {get;set;}
    public int MaxRecordsPerPage {get;set;}
    public List<FilterElement> FilterElements {get;set;}
}

public FilterElement
{
    public string Name {get;set;}
    public object Value {get;set;}
    public bool IgnoreCase {get;set;}
}

现在我想像这样在 GET-Request 中将其作为参数传递：

api/test/records?PageNumber=1&MaxRecordsPerPage=10&FilterElements=%7B%22Name%22%3A%22test%22%2C%20%22Value%22%3A%22x%22%2C%20%22IgnoreCase%22%3A%20true%7D

这样解码：

api/test/records?PageNumber=1&MaxRecordsPerPage=10&FilterElements={"Name":"test", "Value":"x", "IgnoreCase": true}

它将在“FilterElements”-List 中添加一个元素，但该元素只有构造函数中的默认值（我使用的是 [FromURI]）...

如何将我的对象列表传递给 Web 服务？

Answer 1

通过在 GET 参数中放置 JSON 对象，您误用了 GET 方法。根据 w3c，GET 方法只能用于从 Web 服务(See w3schools.com)检索数据

虽然这可能是风格问题，但还有另一个更实际的原因是不将“有效负载”放在 URL 参数中： URL 有长度限制。您传递的列表的大小可能会有所不同，并且您不确定 JSON 序列化列表是否总是比 URL 的最大长度短 (roughly 2000 characters by the way)

我的建议是您在 Web 服务上构建一个 GET 和一个 POST 方法。您可以通过从客户端调用 POST 方法将 FilterElement 列表传递给服务，如下所示：

using (var wb = new WebClient())
{        
    string url = "api/test/records"; //the URL to your web service
    var response = wb.UploadValues(url, "POST", FilterElements); //FilterElements being a list of objects you want to pass
}

然后您将列表存储在 Web 服务会话中（如 here 所示）。 （在此示例中，使用了原始类型，但 Session 也适用于复杂类型）。

在 GET 方法中，您 read the list from the session，进行自定义过滤并返回过滤后的列表。