c# - ASP.NET Web Api 复杂查询参数

Question

我有一个 Web Api 端点，目前是这样调用的:

http://api.example.com/scenes?creationDate=1440091949

我正在尝试支持更复杂的查询，例如:

http://api.example.com/scenes?creationDate.lt=1440091949

注意 .lt 后缀。这将让用户列出所有 creationDate 小于 (lt) 1440091949 的场景。

为此，我必须创建自己的映射器函数，它将每个查询参数映射到查询模型的属性，并将每个查询操作(lt、gt、eq 等)存储在操作字典中:

protected QueryData MapToQueryData(IEnumerable<KeyValuePair<string, string>> queryParameters)
{
     QueryData queryData = new QueryData();

     foreach(var queryParam in queryParameters)
     {
          string[] segments = queryParam.Key.Split('.'); // ["creationDate", "lt"]
          if(!segments.Any()) continue;

          PropertyInfo queryProperty = _reflection.Properties.GetProperty<QueryData>(segments.First()); // "CreationDate" Property
          if(queryProperty == null) continue;

          object value = _reflection.Conversion.ConvertTo(queryParam.Value, property.PropertyType); // Convert 1440091949 to long
          if(value == null) continue;

          _reflection.Properties.SetPropertyValue(queryData, property, value); // Set queryData.CreationDate = 1440091949

          if(segments.Length < 2) continue;

          PropertyInfo mapProperty = _reflection.Properties.GetPropertiesWithAttribute<QueryData, OperationMapAttribute>().FirstOrDefault(); // Identify Property annotated with [OperationMap]
          if(mapProperty == null) continue;

          Dictionary<string, string> operationMap = _reflection.Properties.GetPropertyValue(queryData, mapProperty) as Dictionary<string, string>(); // Get dictionary from Map property
          if(operationMap == null) continue;

          if(!operationMap.ContainsKey(property.Name))
                 operationMap.Add(property.Name, segments.Last()); // "creationDate" -> "lt"
          else
                 operationMap[property.Name] = segments.Last();

          _reflection.Properties.SetPropertyValue(queryData, mapProperty, operationMap); // Set Map property of QueryData to the updated dictionary
     }

     return queryData;
}

我知道如果决定使用 [FromUri] 属性，ASP.NET Web Api 会提供一个自动映射，但如果我有简单的查询参数，比如 creationDate=1440091949，但如果我发送查询参数(例如 creationDate.lt=1440091949)将不起作用。

在 Web API 引擎中是否有内置的东西来处理这些类型的查询参数？我在很多 Web 服务上都见过它们，因此它们在订购或执行复杂查询时非常常见。

Answer 1

您是否尝试过使用 OData 查询语法之类的东西？

http://blogs.msdn.com/b/martinkearn/archive/2015/03/10/using-odata-query-syntax-with-web-api.aspx

从上述...

什么是 OData 查询语法？

OData 查询语法是使用预定义语法查询 RESTful API 的标准方法，允许调用客户端定义排序顺序、过滤器参数和返回的数据页面。

完整的语法可以在 OData 版本 4.0 第 2 部分规范的第 5 节中找到，但这里有一些如何使用语法的快速示例:

• .../host/service/Products?$filter=Name eq 'Milk':返回名称等于'Milk'的所有产品
• .../host/service/Products?$filter=Name eq 'Milk' and Price lt 2.55:返回名称等于'Milk'且价格低于的所有产品大于 2.55
• .../host/service/Products?$top=10&$skip10:返回项目 11>21。 $top 系统查询选项请求查询集合中的项数包含在结果中。 $skip 查询选项请求查询集合中要跳过且不包含在结果中的项目数
• .../host/service/Products?$orderby=Name desc,Id: 返回所有按Name降序排列的产品，然后按Id排列
• .../host/service/Products?$filter=Enabled eq true:返回 Enabled 字段( bool 值)为真的所有产品
• .../host/service/Products?$filter=substringof('Martin', Name): 返回名称字段包含文本 Martin
的所有产品

如何在 ASP.net Web API 中使用 OData 查询语法？

这就是事情变得非常棒的地方 - 更改常规 Web API Controller 以支持 OData 查询语法非常非常容易 - 一旦您知道如何执行此操作，您将永远不会不这样做!

如果我们假设我们从一个常规的 Web API 项目开始(文件 > 新项目 > ASP.net Web 应用程序 > Web API)，您首先需要添加一个脚手架 Controller ，您可以按照以下步骤进行操作:

1. 添加一个模型类(我使用的是带有 Id 的典型“Person”类， 名字、姓氏、年龄等)
2. 右键单击“ Controller ”文件夹 > 添加 > 新脚手架项目 > 带有操作的 Web API 2 Controller ，使用 Entity Framework > Model = 人

注意:您无需选择“Web API 2 OData Controller...”选项，您可以将查询语法添加到任何 Controller

一旦你设置了你的 Controller ，你应该得到一个简单的 Controller ，它有一个默认的 GET 操作，看起来有点像这样:

// GET: api/People
public IQueryable<Person> GetPeople()
{
    return db.People;
}

此操作将简单地返回数据库“People”表中的所有行，无法过滤、排序等。要添加完整的 OData 查询支持，您需要进行一些更改:

1. 通过 nugget 添加 Microsoft.Aspnet.OData 包 ... 只需弹出 这进入你的“包管理器控制台”:安装包 Microsoft.AspNet.Odata
2. 添加此 using 语句:using System.Web.OData;
3. 将 [EnableQueryAttribute] 属性添加到您的 GetPeople 操作。
4. 添加 AsQueryable();到你的返回行，看起来像这样:返回 db.People.AsQueryable();

您完成的代码将如下所示:

// GET: api/People
[EnableQueryAttribute]
public IQueryable<Person> GetPeople()
{
    return db.People.AsQueryable();
}

就是这样! ....现在你有了这个设置，你可以使用完整的 OData 语法来查询排序等，而无需任何额外的代码。