我有一个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服务上都见过它们,因此它们在排序或执行复杂查询时非常常见。
最佳答案
你试过使用odata查询语法吗?
http://blogs.msdn.com/b/martinkearn/archive/2015/03/10/using-odata-query-syntax-with-web-api.aspx
从前面提到的…
什么是OData查询语法?
odata查询语法是使用预定义语法查询restfulapi的标准方法,该语法允许调用客户端定义排序顺序、筛选参数和返回的数据页。
完整的语法可以在OData版本4.0第2部分规范的第5节中找到,但下面是一些如何使用语法的快速示例:
…/主机/服务/产品?$filter=name eq'milk':返回名称等于'milk'的所有产品
…/主机/服务/产品?$filter=name eq'milk'和price lt 2.55:返回名称等于'milk'且价格小于2.55的所有产品
…/主机/服务/产品?$top=10&$skip10:返回项11>21。$top system query选项请求查询集合中要包含在结果中的项目数。$skip query选项请求查询集合中要跳过但不包含在结果中的项目数
…/主机/服务/产品?$order by=name desc,id:返回按名称降序排列的所有产品,然后按id排序
…/主机/服务/产品?$filter=enabled eq true:返回enabled字段(布尔值)为true的所有产品
…/主机/服务/产品?$filter=子字符串('martin',name):
返回名称字段包含文本martin的所有产品
如何在asp.net web api中使用odata查询语法?
这是事情变得非常棒的地方-这是超级,超级容易改变一个常规的web api控制器,以支持odata查询语法-一旦你知道如何做到这一点,你永远不会不这样做!
如果假设我们是从常规的Web API项目(文件>新建项目>ASP.NET Web应用程序>Web API)开始,则首先需要添加一个框架控制器,您可以按照以下步骤执行此操作:
添加一个模型类(我使用的是带有id的典型“person”类,
名字、姓氏、年龄等)
右键单击“控制器”文件夹>添加>新建脚手架项目>
带操作的WebAPI2控制器,使用实体框架>模型=
人
注意:您不需要选择“webapi2odatacontroller…”选项,您可以向任何控制器添加查询语法。
一旦您设置好控制器,您就应该得到一个简单的控制器,它有一个默认的get操作,看起来有点像这样:
// GET: api/People
public IQueryable<Person> GetPeople()
{
return db.People;
}
此操作将只返回数据库“people”表中的所有行,而无法进行筛选、排序等操作。若要添加完整的OData查询支持,您需要进行一些更改:
通过掘金添加Microsoft.aspnet.odata包…简单地流行
这将进入“包管理器控制台”:安装包
微软.aspnet.odata
添加此using语句:using system.web.odata;
将[enableQueryAttribute]属性添加到getPeople操作。
将asqueryable()添加到返回行中,如下所示:return
db.people.asqueryable();
完成的代码将如下所示:
// GET: api/People
[EnableQueryAttribute]
public IQueryable<Person> GetPeople()
{
return db.People.AsQueryable();
}
这就是它的全部!……现在您有了这个设置,您可以使用完整的odata语法来查询sort etc,而不需要任何额外的代码。