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 条评论
登录 后参与评论

相关文章

来自专栏葡萄城控件技术团队

程序员Web面试之JSON

JSON是什么? JSON(JavaScript对象表示法), 是在网络通信下,常用的一种数据表达格式,它有助于我们于一个自描述的,独立的和轻的方式呈现并交换数...

20010
来自专栏技术博客

Asp.Net Web API 2第十六课——Parameter Binding in ASP.NET Web API(参数绑定)

阅读本文之前,您也可以到Asp.Net Web API 2 系列导航进行查看 http://www.cnblogs.com/aehyok/p/3446289.h...

593
来自专栏DOTNET

asp.net web api 异常捕获

1 向客户端发送错误消息 使用throw new HttpResponseException()向客户端抛出错误信息。 HttpResponseExceptio...

44212
来自专栏菩提树下的杨过

dubbox REST服务使用fastjson替换jackson

上一节讲解了resteasy如何使用fastjson来替换默认的jackson,虽然dubbox内部采用的就是resteasy,但是大多数情况下,dubbox服...

18810
来自专栏微信公众号:Java团长

SSM框架——实现分页和搜索分页

分页是Java Web项目常用的功能,昨天在Spring MVC中实现了简单的分页操作和搜索分页,在此记录一下。使用的框架为(MyBatis+SpringMVC...

934
来自专栏大魏分享(微信公众号:david-share)

实战:应用对持久数据访问| 从开发角度看应用架构9

JPA的API有主要以下几个:实体(entity)、持久性单元(persistence units)、持久性上下文( persistence context)、...

873
来自专栏Bug生活2048

Spring Boot学习笔记(六)结合MyBatis实现较为复杂的RESTful API

首先看下要实现的效果吧,完成下面截图部分的API,除了CRUD之外,分页查询也是使用的比较多的。

652
来自专栏大内老A

ASP.NET MVC路由扩展:链接和URL的生成

ASP.NET 路由系统通过注册的路由表旨在实现两个“方向”的路有功能,即针对入栈请求的路由和出栈URL的生成。前者通过调用代表全局路由表的RouteColle...

1897
来自专栏技术小讲堂

在ASP.NET MVC中使用Unity进行依赖注入的三种方式第一种方法第二种方法第三种方法

     在ASP.NET MVC4中,为了在解开Controller和Model的耦合,我们通常需要在Controller激活系统中引入IoC,用于处理用户请...

2695
来自专栏Lambda

编程规范

领域层–编码规范 2018年4月4日14:10:38 Controller层编写规范 controller层只是负责从service层获得数据,对外暴露API接...

3385

扫码关注云+社区