快速搭建WebAPI(Odata+Code-First)附Odata条件查询表~
Odata是什么?
开放数据协议(Open Data Protocol,缩写OData)是一种描述如何创建和访问Restful服务的OASIS标准。该标准由微软发起,前三个版本1.0、2.0、3.0都是微软开放标准,遵循 [1] 。第四个版本4.0于2014年3月17日在OASIS投票通过成为开放工业标准 [2] 。
为什么需要OData?
OData是一个协议,一个标准。所以这个问题等同于为什么我们需要协议。类比TCP协议就可以理解一般。假设你开发的组件必须要和某个第三方组件通信,如果第三方组件不支持TCP而只支持其内部开发的一个私有协议,你就肯定头大了,你必须在你的组件里单独为其实现这个私有协议。如果大家都支持TCP协议,不就省事了么。这就是标准协议的作用:协议和标准用于制定一个统一通用的规则。 我们只需要按照这个协议或标准生产组件,那么这个组件就可以方便的和其他组件集成/协作。而无须根据其他组件的私有标准定制化组件。
如何使用OData?
Odata目前已经不怎么更新了,目前最高的5.7已经停留在2015年8月21 远古时代,然后我们还需要在WebApiConfig.cs中配置Odata
ODataModelBuilder builder = new ODataConventionModelBuilder();
builder.EntitySet<TRoles>("TRoles");
builder.EntitySet<TUsers>("TUsers");
builder.EntitySet<TUsersRoles>("TUsersRoles");
config.Routes.MapODataServiceRoute("odata", "odata", builder.GetEdmModel());
其中builder.EntitySet<TRoles>("TRoles"); 需要注意的是EntitySet这个方法是对你的实体类进行配置,其底层是要获取的类型放到它的配置项里。
Code-First 方式 create DataBase
Context.cs
public Model1()
: base("name=CodeFirstDemo")
{
} public DbSet<TUsers> Users { get; set; }
public DbSet<TRoles> Roles { get; set; }
public DbSet<TUsersRoles> UsersRoles { get; set; }
其它的三个类就不写上来了,不想占用博客园的资源,也不想写没有意义的!
创建webAPIController
创建完的代码展示:
using System;
using System.Collections.Generic;
using System.Data;
using System.Data.Entity;
using System.Data.Entity.Infrastructure;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;
using System.Web.Http.ModelBinding;
using System.Web.Http.OData;
using System.Web.Http.OData.Routing;
using heheda.Models; namespace heheda.Controllers
{
/*
The WebApiConfig class may require additional changes to add a route for this controller. Merge these statements into the Register method of the WebApiConfig class as applicable. Note that OData URLs are case sensitive. using System.Web.Http.OData.Builder;
using System.Web.Http.OData.Extensions;
using heheda.Models;
ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
builder.EntitySet<TRoles>("TRoles");
builder.EntitySet<TUsersRoles>("UsersRoles");
config.Routes.MapODataServiceRoute("odata", "odata", builder.GetEdmModel());
*/
public class TRolesController : ODataController
{
private Model1 db = new Model1(); // GET: odata/TRoles
[EnableQuery]
public IQueryable<TRoles> GetTRoles()
{
return db.Roles;
} // GET: odata/TRoles(5)
[EnableQuery]
public SingleResult<TRoles> GetTRoles([FromODataUri] int key)
{
return SingleResult.Create(db.Roles.Where(tRoles => tRoles.Id == key));
} // PUT: odata/TRoles(5)
public IHttpActionResult Put([FromODataUri] int key, Delta<TRoles> patch)
{
Validate(patch.GetEntity()); if (!ModelState.IsValid)
{
return BadRequest(ModelState);
} TRoles tRoles = db.Roles.Find(key);
if (tRoles == null)
{
return NotFound();
} patch.Put(tRoles); try
{
db.SaveChanges();
}
catch (DbUpdateConcurrencyException)
{
if (!TRolesExists(key))
{
return NotFound();
}
else
{
throw;
}
} return Updated(tRoles);
} // POST: odata/TRoles
public IHttpActionResult Post(TRoles tRoles)
{
if (!ModelState.IsValid)
{
return BadRequest(ModelState);
} db.Roles.Add(tRoles);
db.SaveChanges(); return Created(tRoles);
} // PATCH: odata/TRoles(5)
[AcceptVerbs("PATCH", "MERGE")]
public IHttpActionResult Patch([FromODataUri] int key, Delta<TRoles> patch)
{
Validate(patch.GetEntity()); if (!ModelState.IsValid)
{
return BadRequest(ModelState);
} TRoles tRoles = db.Roles.Find(key);
if (tRoles == null)
{
return NotFound();
} patch.Patch(tRoles); try
{
db.SaveChanges();
}
catch (DbUpdateConcurrencyException)
{
if (!TRolesExists(key))
{
return NotFound();
}
else
{
throw;
}
} return Updated(tRoles);
} // DELETE: odata/TRoles(5)
public IHttpActionResult Delete([FromODataUri] int key)
{
TRoles tRoles = db.Roles.Find(key);
if (tRoles == null)
{
return NotFound();
} db.Roles.Remove(tRoles);
db.SaveChanges(); return StatusCode(HttpStatusCode.NoContent);
} // GET: odata/TRoles(5)/TRolesUsersList
[EnableQuery]
public IQueryable<TUsersRoles> GetTRolesUsersList([FromODataUri] int key)
{
return db.Roles.Where(m => m.Id == key).SelectMany(m => m.TRolesUsersList);
} protected override void Dispose(bool disposing)
{
if (disposing)
{
db.Dispose();
}
base.Dispose(disposing);
} private bool TRolesExists(int key)
{
return db.Roles.Count(e => e.Id == key) > 0;
}
}
}
在之后我们就可以在前端中去通过这个协议规则去过滤我们的数据了!
Odata筛选数据规则表
操作 |
URL |
说明 |
$filter | http://localhost:8090/api/Meetings?$filter=ProductName eq 'Tofu' | 根据表达式的状态返回结果(返回ProductName 等于Tofu的Products) |
$orderby | http://localhost:8090/api/Meetings?$orderby=ProductName | 根据结果排序(根据ProductName列排序) |
$skip | http://localhost:8090/api/Meetings?$skip=10 | 越过结果中的n条数据,常用于分页 |
$top | http://localhost:8090/api/Meetings?$top=10 | 返回结果中的前n条记录,常用于分页 |
$select | http://localhost:8090/api/Meetings?$filter=ProductName eq 'Tofu'&$select=ProductName,UnitPrice | 选择需要返回的属性 |
$expand | http://localhost:8090/api/Meetings?$expand=Supplier | 返回Products中包含的导航属性(关联属性)Supplier |
$inlinecount | http://localhost:8090/api/Meetings?$inlinecount=allpages | 向服务器获取符合条件的资源总数(分页的total值) |
快速搭建WebAPI(Odata+Code-First)附Odata条件查询表~的更多相关文章
- [转]OData的初步认识 OData v4 Client Code Generator
本文转自:http://www.cnblogs.com/1zhk/p/5356053.html What – OData是什么? OData - Open Data Protocol,是一个设计和使用 ...
- .net core系列之《sdk和runtime区别及使用CLI在Ubuntu上快速搭建Console,WebApi,MVC三大应用模型》
一.需要安装的软件 1.虚拟机安装Ubuntu系统(本人用的是vmware-14.1.12和buntu-18.04) 2.Xshell或 Putty(连接ssh服务) 3.FileZilla(ftp上 ...
- 利用Columnal网格系统快速搭建网站的基本布局结构
1.下面是一些对响应式设计提供了不同程度支持的CSS框架: (1)Semantic(http://semantic.gs); (2)Skeleton(http://getskeleton.com); ...
- Jenkins+Maven+SVN快速搭建持续集成环境(转)
Jenkins是一个可扩展的持续集成引擎,Jenkins非常易于安装和配置,简单易用,下面看看我们是如何几分钟就快速搭建一个持续集成环境吧. 假设我们目前已经有2个maven项目:entities(J ...
- WAMP Server助你在Windows上快速搭建PHP集成环境
WAMP Server助你在Windows上快速搭建PHP集成环境 原文地址 我想只要爬过几天网的同学都会知道PHP吧,异次元的新版本就是基于PHP的WordPress程序制造出来的,还有国内绝大部分 ...
- 拿nodejs快速搭建简单Oauth认证和restful API server攻略
拿nodejs快速搭建简单Oauth认证和restful API server攻略:http://blog.csdn.net/zhaoweitco/article/details/21708955 最 ...
- 基于 Jenkins 快速搭建持续集成环境--转
源地址:http://www.ibm.com/developerworks/cn/java/j-lo-jenkins/ 持续集成是一种软件开发实践,对于提高软件开发效率并保障软件开发质量提供了理论基础 ...
- Jenkins 快速搭建持续集成环境
持续集成概述 什么是持续集成 随着软件开发复杂度的不断提高,团队开发成员间如何更好地协同工作以确保软件开发的质量已经慢慢成为开发过程中不可回避的问题.尤其是近些年来,敏捷(Agile) 在软件工程领域 ...
- Jenkins快速搭建持续集成
基于Jenkins快速搭建持续集成环境 Jenkins+tortoisesvn+MSBuild做到持续集成 附Jenkins的使用:http://www.infoq.com/cn/articles/M ...
随机推荐
- Java排序 - 不实用的几个排序算法 -- 睡眠排序、猴子排序、面条排序、珠排序
介绍几个不实用的排序算法,一来可以在学习时增加一些乐趣,放松一下自己,二来可以学习一下.思考一下这些算法失败在哪里,又是否存在一些好的地方? 睡眠排序 这是一个思想比较简单,脑洞巨大的算法 -- 我们 ...
- ImCash:币圈英文术语大全
近年来随着数字货币的火热,在全世界范围内涌现出了一群数字货币的“发烧友”和忠实投资者,他们形成了自己的圈子“币圈”,并且有了自己的文化和语言,今天就让我们一起来了解一下外国币圈有哪些有意思的英文“专用 ...
- Codeforces 446A. DZY Loves Sequences (线性DP)
<题目链接> 题目大意: 给定一个长度为$n$的序列,现在最多能够改变其中的一个数字,使其变成任意值.问你这个序列的最长严格上升子段的长度是多少. #include <bits/st ...
- 彻底卸载MySQL服务
前言 由于安装某个项目的执行文件,提示要卸载MySQL以便它自身MySQL安装,然后我禁用了MYSQL服务,再把这个文件夹删除后,发现还是提示请卸载MYSQL服务. ----------------- ...
- SQL Server 优化
SELECT TOP 10 [Total Cost] = ROUND(avg_total_user_cost * avg_user_impact * (user_seeks + user_scans) ...
- UI分层中使用PageFactory
基于原PO设计模式,需要改变原有的从文件中读取文件,更改为PageFactory模式.做出如下改动: 1 2 public MsysPage(DriverBase driver) { super(dr ...
- eclipse自身导致的项目问题:上边提示需要移除无用包,下边类提示需要导入包。
- go语言数据库操作,xorm框架
待续............................................... 连接数据库 db, err := xorm.NewEngine("mysql", ...
- css 制作导航条布局
代码: <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8 ...
- python学习:输入设置
输入设置 输入用户名和密码 代码: _user = "alex"_password = "abc123" username = input("User ...