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方式。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏jessetalks

async & await 的前世今生(Updated)

async 和 await 出现在C# 5.0之后,给并行编程带来了不少的方便,特别是当在MVC中的Action也变成async之后,有点开始什么都是asyn...

34111
来自专栏技术博客

C#函数方法集

1、DateTime 数字型 System.DateTime currentTime=new System.DateTime();

1192
来自专栏我和未来有约会

向silverlight传递自定义参数

在silverlight往往还是有一些获取不到的东西,比如说客户机的ip等的数据.可以通过初始化sl时把参数传入sl中. 1.修改page类 public P...

1879
来自专栏Create Sun

mvc+webapi 单元测试 3.使用Moq模拟AspnetMvc中的Request.Form

 1.前言     现在这个项目已经有阶段性的模块完成了,所以就想着对这些模块进行单元测试,以保证项目的代码的质量。首先虽然标题是mvc+webapi实质上我只...

5579
来自专栏飞扬的花生

C#中返回值封装

      在平时开发过程中常常需要取一个方法的返回值,BOSS写了一个返回值类,做个练习以备不时之需: 返回值支持泛型和非泛型 先贴上代码: 非泛型返回值类:...

22110
来自专栏非著名程序员

Android开发工具类之HttpUtils

今天我们讲常用的开发工具类之HttpUtils,我发现上两次,我对于每个方法都进行了一定的解释,有人跟我评论和留言说,不用我解释,这么简单,这么明显的使用方法,...

2145
来自专栏c#开发者

Winform 的一个多线程绑定DataGrid数据源的例子

我们都知道简单的运用多线程的方法有 1/ Thread thread=new Thread(new StartThread(this.method))     ...

2959
来自专栏跟着阿笨一起玩NET

Linq to XML 读取XML 备忘笔记

本文转载:http://www.cnblogs.com/infozero/archive/2010/07/13/1776383.html

830
来自专栏圣杰的专栏

Parallel线程安全问题

废话不多说,上代码: using System; using System.Collections.Generic; using System.Threadin...

3185
来自专栏hbbliyong

Json的序列化与反序列化以及乱入的k_BackingField

  今天需要使用Json数据,所以用到了Json的序列化与反序列化。首先先来说怎么序列化的: 1.序列化与反序列化   首先添加System.Runtime.S...

2535

扫码关注云+社区