asp.net web api 使用Odata

路由配置

routePrefix路由前缀,必须含有Odata字符串,否则路由不到Odata控制器。

V1表示版本,可以使用这种方式进行版本控制,也可以使用其他方式。

config.Count().Filter().OrderBy().Expand().Select().MaxTop(null);这样配置使Odata操作符可用(Web Api2的旧版本不必如此设置)。

public static class WebApiConfig
{
        public static void Register(HttpConfiguration config)
        {
            //odata路由
            config.MapODataServiceRoute(
                           routeName: "V1OdataRouteVersioning",
                           routePrefix: "Odata/V1",
                           model: GetEdmModel());
            config.Count().Filter().OrderBy().Expand().Select().MaxTop(null);
            config.AddODataQueryFilter();
        }
}        

EDM模型配置

实体名称为Collection,控制器名称为CollectionsV1Controller,Action名称为AddCollection,collectionBM为方法参数名称。Function名称为GetCollection,Function返回数据类型为CollectionDTO,Function参数名为userId。使用ODataConventionModelBuilder.Namespace定义命名空间,他是请求URI的一部分。

public class CollectionsV1Controller : ODataController
    {
        [EnableQuery]
        [HttpGet]
        public List<CollectionDTO> GetCollection(int userId)
        {
            return CollectionBLL.GetCollection(userId);
        }

        [HttpPost]
        public int AddCollection(CollectionBindingModel collectionBM)
        {
            return CollectionBLL.AddCollection(collectionBM);
        }
}

private static IEdmModel GetEdmModel()
{
            ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
       var collectionSet = builder.EntitySet<Collection>("Collections").EntityType.Collection;
            var getCollectionFunction = collectionSet.Function("GetCollection").Returns<CollectionDTO>();
            getCollectionFunction.Parameter<int>("userId");

            collectionSet.Action("AddCollection").Returns<int>().Parameter<CollectionBindingModel>("collectionBM");

            var deleteCollectionFunction = collectionSet.Function("DeleteCollection").Returns<int>();
       deleteCollectionFunction.Parameter<int>("collectionUserId");
       builder.Namespace = "Service";
            return builder.GetEdmModel();
}

控制器与控制器方法

控制器继承自ODataController,ODataController上有[ApiExplorerSettings(IgnoreApi = true)]

,[ODataFormatting],[ODataRouting]这三个特性,由于[ApiExplorerSettings(IgnoreApi = true)]

的影响,在System.Web.Http.Description.ApiDescription实例中不包含继承自ODataController的控制器;控制器方法使用了[EnableQuery]修饰后才可支持Odata操作符。

自定义方法的方式有两种,使用EntityCollectionConfiguration<TEntityType>.Action或EntityCollectionConfiguration<TEntityType>.Function。

使用EntityCollectionConfiguration<TEntityType>.Action定义的控制器方法可以通过body体传参;

使用EntityCollectionConfiguration<TEntityType>.Function定义的控制器方法可以通过url传参,但url写法值得注意,例如:http://localhost/HY_WebApi/Odata/V1/Collections/Service.GetCollection(userId=3),注意这里使用了括号将参数括起来,而不是“?userId=3”这种格式

使用Action,不支持HttpGet方式,仅支持HttpPost方式。

Function仅支持HttpGet方式,不支持HttpPost方式。

时间: 2024-10-08 08:58:36

asp.net web api 使用Odata的相关文章

ASP.NET Web API基于OData的增删改查,以及处理实体间关系

本篇体验实现ASP.NET Web API基于OData的增删改查,以及处理实体间的关系. 首先是比较典型的一对多关系,Supplier和Product. public class Product { public int Id { get; set; } public string Name { get; set; } public decimal Price { get; set; } public string Category { get; set; } [ForeignKey("Sup

[转]ASP.NET web API 2 OData enhancements

本文转自:https://www.pluralsight.com/blog/tutorials/asp-net-web-api-2-odata-enhancements Along with the release of Visual Studio 2013 came a new release of ASP.NET MVC (called MVC 5) and ASP.NET Web API (called Web API 2). Part of the enhancements to the

[转]Using $select, $expand, and $value in ASP.NET Web API 2 OData

本文转自:https://docs.microsoft.com/en-us/aspnet/web-api/overview/odata-support-in-aspnet-web-api/using-select-expand-and-value by Mike Wasson+ Web API 2 adds support for the $expand, $select, and $value options in OData. These options allow a client to

[转]ASP.NET Web API对OData的支持

http://www.cnblogs.com/shanyou/archive/2013/06/11/3131583.html 在SOA的世界中,最重要的一个概念就是契约(contract).在云计算的世界中,有关通信的最重要的概念也是契约.XML具有强大对数据的描述能力,Atom格式和AtomPub都建立在XML之上,在Google和微软的推动下,也已经成为标准.但是,Atom/AtomPub和ODBC/OLEDB这样的真正数据交互协议相比较,还有着根本上的欠缺:缺乏数据类型的具体描述,降低了交

ASP.NET Web API对OData的支持

小分享:我有几张阿里云优惠券,用券购买或者升级阿里云相应产品最多可以优惠五折!领券地址:https://promotion.aliyun.com/ntms/act/ambassador/sharetouser.html?userCode=ohmepe03 在SOA的世界中,最重要的一个概念就是契约(contract).在云计算的世界中,有关通信的最重要的概念也是契约.XML具有强大对数据的描述能力,Atom格式和AtomPub都建立在XML之上,在Google和微软的推动下,也已经成为标准.但是

对一个前端AngularJS,后端OData,ASP.NET Web API案例的理解

依然chsakell,他写了一篇前端AngularJS,后端OData,ASP.NET Web API的Demo,关于OData在ASP.NET Web API中的正删改查没有什么特别之处,但在前端调用API时,把各种调用使用$resouce封装在一个服务中的写法颇有借鉴意义. 文章:http://chsakell.com/2015/04/04/asp-net-web-api-feat-odata/源码:https://github.com/chsakell/odatawebapi 首先是领域模

ASP.NET Web API系列教程(目录)(转)

注:微软随ASP.NET MVC 4一起还发布了一个框架,叫做ASP.NET Web API.这是一个用来在.NET平台上建立HTTP服务的Web API框架,是微软的又一项令人振奋的技术.目前,国内对此关注的人似乎还不多,有关ASP.NET Web API的文章也不多见.为此,本人打算对微软ASP.NET Web API官方网站上的一些教程进行翻译,以期让更多的国人了解.学习和使用这项ASP.NET Web API. ASP.NET Web API系列教程目录 Introduction:Wha

ASP.NET Web API系列教程目录

ASP.NET Web API系列教程目录 Introduction:What's This New Web API?引子:新的Web API是什么? Chapter 1: Getting Started with ASP.NET Web API第1章 ASP.NET Web API入门 Your First Web API (C#)第一个Web API(C#) Deep Dive into Web API深入探讨Web API(这是一个视频教程,本翻译系列略) Pro ASP.NET Web

ASP.NET Web API中使用OData

在ASP.NET Web API中使用OData 一.什么是ODataOData是一个开放的数据协议(Open Data Protocol)在ASP.NET Web API中,对于CRUD(create, read, update, and delete)应用比传统WebAPI增加了很大的灵活性只要正确使用相关的协议,可以在同等情况下对一个CRUD应用可以节约很多开发时间,从而提高开发效率 二.怎么搭建 做一个简单的订单查询示例我们使用Code First模式创建两个实体对象Product(产品