请MVC5 WebApi2 支持OData协议查询
一、配置项
1、WebApiConfig.cs添加如下代码:
// api 支持 cors允许Ajax发起跨域的请求(nuget 中搜索 ASP.NET Cross-Origin Support,然后安装)
var cors = new System.Web.Http.Cors.EnableCorsAttribute("*", "*", "*");
config.EnableCors(cors);
// api 支持 odata 查询( nuget 中搜索 ASP.NET Web API OData)
System.Web.Http.OData.Extensions.HttpConfigurationExtensions.AddODataQueryFilter(config);
2、Global.asax.cs添加如下代码:
//添加 ASP.NET Web API 2 的 全部集合,注意这个要放在前面
GlobalConfiguration.Configure(WebApiConfig.Register);
RouteConfig.RegisterRoutes(RouteTable.Routes);
二、使用方法
ODataController.cs
[EnableQuery(AllowedQueryOptions = AllowedQueryOptions.All)]
//[EnableQuery(MaxTop = 100)] // 指定 top 参数的最大值为 100
//[EnableQuery(AllowedQueryOptions = AllowedQueryOptions.Skip | AllowedQueryOptions.Top)]
public IQueryable<Sites> Get()
{
List<Sites> siteslist = ...;
return siteslist.AsQueryable();
}
三、查询示例:
1、 查询前10条数据,并返回Id值小于10的数据集合:
http://localhost:49636/api/odata?$top=10&$filter=Id lt 10
2、查询ParnetId等于6551的数据人集合:
http://localhost:49636/api/app?$filter=ParentId eq 6551
3、上面的集合按照Code倒序排列:
http://localhost:49636/api/app?$filter=ParentId eq 6551&$orderby=Code desc
4、只返回Name,Id属性的集合:
http://localhost:49636/api/app?$format=json&$select=Name,Id
运算符 | 描述 | 示例 |
---|---|---|
eq |
等于 |
|
ne |
不等于 |
|
gt |
大于 |
|
ge |
大于或等于 |
|
Lt |
小于 |
|
le |
小于或等于 |
|
and |
逻辑与 |
|
or |
逻辑或 |
|
not |
逻辑非 |
|
选项 | 说明 |
---|---|
指示应在所检索的记录或集合中检索相关记录。 |
|
指定为在集合中返回记录计算结果必须为 true 的表达式或函数。 |
|
确定使用哪些值对记录集合进行排序。 |
|
指定要返回的属性子集。 |
|
设置在集合中检索记录之前要跳过的记录数。 |
|
确定要返回的最大记录数。 |
相关教程:http://www.asp.net/web-api/overview/odata-support-in-aspnet-web-api
The Service:
It all starts with a Data Service hosted somewhere:
http://server/service.svc
Basic queries:
You access the Data Service entities through resource sets, like this:
http://server/service.svc/People
You request a specific entity using its key like this:
http://server/service.svc/People(16)
Or by using a reference relationship to something else you know:
http://server/service.svc/People(16)/Mother
This asks for person 16’s mother.
Once you have identified an entity you can refer to it’s properties directly:
http://server/service.svc/People(16)/Mother/Firstname
$value:
But the last query wraps the property value in XML, if you want just the raw property value you append $value to the url like this:
http://server/service.svc/People(16)/Mother/Firstname/$value
$filter:
You can filter resource sets using $filter:
http://server/service.svc/People?$filter=Firstname eq ‘Fred’
Notice that strings in the filter are single quoted.
Numbers need no quotes though:
http://server/service.svc/Posts?$filter=AuthorId eq 1
To filter by date you have identity the date in the filter, like this:
http://server/service.svc/Posts?$filter=CreatedDate eq DateTime’2009-10-31′
You can filter via reference relationships:
http://server/service.svc/People?$filter=Mother/Firstname eq ‘Wendy’
The basic operators you can use in a filter are:
Operator |
Description |
C# equivalent |
eq |
equals |
== |
ne |
not equal |
!= |
gt |
greater than |
> |
ge |
greater than or equal |
>= |
lt |
less than |
< |
le |
less than or equal |
<= |
and |
and |
&& |
or |
or |
|| |
() |
grouping |
() |
There are also a series of functions that you can use in your filters if needed.
$expand:
If you want to include related items in the results you use $expand like this:
http://server/service.svc/Blogs?$expand=Posts
This returns the matching Blogs and each Blog’s posts.
$select:
Some Data Services allow you to limit the results to just the properties you require – aka projection – for example if you just want the Id and Title of matching Posts you would need something like this:
http://server/service.svc/Posts?$select=Id,Title
You can even project properties of related objects too, like this:
http://server/service.svc/Posts?$expand=Blog&$select=Id,Title,Blog/Name
This projects just the Id, Title and the Name of the Blog for each Post.
$count:
If you just want to know how many records would be returned, without retrieving them you need $count:
http://server/service.svc/Blogs/$count
Notice that $count becomes one of the segments of the URL – it is not part of the query string – so if you want to combine it with another operation like $filter you have to specify $count first, like this:
http://server/service.svc/Posts/$count?$filter=AuthorId eq 6
This query returns the number of posts authored by person 6.
$orderby:
If you need your results ordered you can use $orderby:
http://server/service.svc/Blogs?$orderby=Name
Which returns the results in ascending order, to do descending order you need:
http://server/service.svc/Blogs?$orderby=Name%20desc
To filter by first by one property and then by another you need:
http://server/service.svc/People?$orderby=Surname,Firstname
Which you can combine with desc if necessary.
$top:
If you want just the first 10 items you use $top like this:
http://server/service.svc/People?$top=10
$skip:
If you are only interested in certain page of date, you need $top and $skip together:
http://server/service.svc/People?$top=10&$skip=20
This tells the Data Service to skip the first 20 matches and return the next 10. Useful if you need to display the 3rd page of results when there are 10 items per page.
Note: It is often a good idea to combine $top & $skip with $orderby too, to guarantee the order results are retrieved from the underlying data source is consistent.
$inlinecount & $skiptoken:
Using $top and $skip allows the client to control paging.
But the server also needs a way to control paging – to minimize workload need to service both naive and malicious clients – the OData protocol supports this via Server Driven Paging.
With Server Driven Paging turned on the client might ask for every record, but they will only be given one page of results.
This as you can imagine can make life a little tricky for client application developers.
If the client needs to know how many results there really are, they can append the $inlinecount option to the query, like this:
http://server/service.svc/People?$inlinecount=allpages
The results will include a total count ‘inline’, and a url generated by the server to get the next page of results.
This generated url includes a $skiptoken, that is the equivalent of a cursor or bookmark, that instructs the server where to resume:
http://server/service.svc/People?$skiptoken=4
$links
Sometime you just need to get the urls for entities related to a particular entity, which is where $links comes in:
http://server/service.svc/Blogs(1)/$links/Posts
This tells the Data Service to return links – aka urls – for all the Posts related to Blog 1.
$metadata
If you need to know what model an OData compliant Data Service exposes, you can do this by going to the root of the service and appending $metadata like this:
http://server/service.svc/$metadata
This should return an EDMX file containing the conceptual model (aka EDM) exposed by the Data Service.
请MVC5 WebApi2 支持OData协议查询的更多相关文章
- 让Asp.net mvc WebAPI 支持OData协议进行分页查询操作
这是我在用Asp.net mvc WebAPI 支持 OData协议 做分页查询服务时的 个人拙笔. 代码已经开发到oschina上.有兴趣的朋友可以看看,欢迎大家指出不足之处. 看过了园子里的几篇关 ...
- 让Asp.Net WebAPI支持OData查询,排序,过滤。
让Asp.Net WebAPI支持OData后,就能支持在url中直接输入排序,过滤条件了. 一.创建Asp.Net WebAPI项目: 二.使用NuGet安装Asp.Net WebAPI 2.2和O ...
- 让Asp.Net WebAPI支持OData查询,排序,过滤。(转)
出处:http://www.cnblogs.com/liuzhendong/p/4233380.html 让Asp.Net WebAPI支持OData后,就能支持在url中直接输入排序,过滤条件了. ...
- AspNet.OData 协议概述
1. 什么是OData? OData 全称 Open Data Protocol,字面理解为开放数据协议,是一个基于Http协议且API实现为Restful风格的协议标准,目前由微软支持大力推广,你可 ...
- WCF Data Service 使用小结 (一)—— 了解OData协议
最近做了一个小项目,其中用到了 WCF Data Service,之前是叫 ADO.NET Data Service 的.关于WCF Data Service,博客园里的介绍并不多,但它确实是个很好的 ...
- 使用 node-odata 轻松创建基于 OData 协议的 RESTful API
前言 OData, 相信身为.NET程序员应该不为陌生, 对于他的实现, 之前也有童鞋进行过介绍(见:这里1,这里2). 微软的WCF Data Service即采用的该协议来进行通信, ASP.NE ...
- 阿里云全站加速DCDN全面支持WebSocket协议
WebSocket协议可以为网站和应用提供真正的双向通信,具有控制开销.保持连接状态.更强实时性.更好的压缩效果等优点,是当下低延时应用最常采用的一种技术协议.为了更好的满足客户在实时通讯场景下的加速 ...
- 1、大部分社交平台接口不支持https协议。
参考文献来自:http://wiki.mob.com/ios9-%E5%AF%B9sharesdk%E7%9A%84%E5%BD%B1%E5%93%8D%EF%BC%88%E9%80%82%E9%85 ...
- 精通Dubbo——Dubbo支持的协议的详解
转: 精通Dubbo——Dubbo支持的协议的详解 2017年06月02日 22:26:57 孙_悟_空 阅读数:44500 Dubbo支持dubbo.rmi.hessian.http.webse ...
随机推荐
- poj2117 Electricity
试题描述 求一个图删除一个点之后,联通块最多有多少. 输入 多组数据.第一行两个整数 P,C 表示点数和边数.接下来 C 行每行两个整数 p1,p2,表示 p1 与 p2 有边连接,保证无重边.读 ...
- Codeforces Round #348 (VK Cup 2016 Round 2, Div. 2 Edition) C. Little Artem and Matrix 模拟
C. Little Artem and Matrix 题目连接: http://www.codeforces.com/contest/669/problem/C Description Little ...
- Codeforces Beta Round #4 (Div. 2 Only) A. Watermelon 水题
A. Watermelon 题目连接: http://www.codeforces.com/contest/4/problem/A Description One hot summer day Pet ...
- sklearn中的投票法
投票法(voting)是集成学习里面针对分类问题的一种结合策略.基本思想是选择所有机器学习算法当中输出最多的那个类. 分类的机器学习算法输出有两种类型:一种是直接输出类标签,另外一种是输出类概率,使用 ...
- reservoid sample 蓄水池问题
题目:怎样从无穷尽流中等概率的抽样出一个单词? 也许我们换一种说法会更加easy理解.等概率的抽取出一个单词,也即随机的抽取一个单词. 本体的难点在于没有给定单词数,而是一个无尽的流. 这个问题能够用 ...
- 介绍:一款Mathematica的替代开源软件Mathetics
Mathetics软件 1 以Python语言实现该系统 2 软件使用的语法与Mathematica同样 3 下载:http://www.mathics.org/ 4 手冊:http://www.ma ...
- 搭建windows server 2008 r2 FTP 后 开启防火墙无法访问的解决办法
转自http://kkworms.blog.51cto.com/540865/558477 今天在windows server 2008 R2上安装了FTP,安装过程如下,然后添加内置防火墙设置,设置 ...
- mysql-bin.000001
今天发现/usr/local/mysql/var下很多mysql-bin.000001.mysql-bin.000002文件,GOOGLE之..这是数据库的操作日志,例如UPDATE一个表,或者DEL ...
- Choosing an ORM strategy
One of the mistakes I see people make (and have made myself) is assuming that you must choose exactl ...
- 辛星跟您解析在CSS面包屑中三角形的定位问题
刚才看到有位网友非常纳闷第二个棕色三角形是怎么定位的,我当感觉在以下说不清楚,就特别开了一片博客.来说清楚它.首先,前面的代码我们先抄下来,至于前面这部分代码是怎么来的,读我的用CSS制作面包屑导航的 ...