开放数据协议 (OData) 是一种用于 web 的数据访问协议
OData 提供统一的方式来查询和操做数据集经过 CRUD 操做 (建立、 读取、 更新和删除)
如下以asp .net为例做讲解html
引用git
Microsoft.AspNet.WebApi Microsoft.AspNet.WebApi.Client Microsoft.AspNet.WebApi.Cors Microsoft.AspNet.WebApi.WebHost
在App_Start中添加类文件WebApiConfig.csgithub
public class WebApiConfig { public static void Register(HttpConfiguration configuration) { configuration.Routes.MapHttpRoute("API Default", "api/{controller}/{id}", new { id = RouteParameter.Optional }); } }
修改Global.asax.cs文件,注入WebApiConfigweb
//在注册默认路由以前 before registering the default Web Application route as that would otherwise take precedence. WebApiConfig.Register(GlobalConfiguration.Configuration); RouteConfig.RegisterRoutes(RouteTable.Routes);
How to add Web API to an existing ASP.NET MVC 4 Web Application project?c#
分Server和Client两部分api
配置mvc
ODataModelBuilder builder = new ODataConventionModelBuilder(); //多个实体,不能重名 builder.EntitySet<Product>("Products"); builder.EntitySet<Supplier>("Suppliers"); //定义自定义方法 builder.Function("GetSalesTaxRate") .Returns<double>() .Parameter<int>("PostalCode"); configuration.MapODataServiceRoute( routeName: "ODataRoute", routePrefix: null, model: builder.GetEdmModel());
实现相关接口
完成以后,运行or发布Server,保证可以访问app
新建控制台(任意客户端)
安装工具(须要重启VS)
新建服务代理
配置服务代理:打开.tt文件,如图所示,有一个MetadataDocumentUri参数,配置为Server的网址,保存以后,会自动生成服务代理(更新也是这个步骤)
调用服务工具
string serviceUri = "http://localhost:5003/"; var container = new Default.Container(new Uri(serviceUri)); //调用自定义方法 var rate = container.GetSalesTaxRate(1);
建立 OData v4 终结点使用 ASP.NET Web API
建立 OData v4 客户端应用 (C#)
OData – the best way to REST–实例讲解ASP.NET WebAPI OData (V4) Service & Client