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

相关文章

来自专栏JackieZheng

Spring实战——缓存

缓存 提到缓存,你能想到什么?一级缓存,二级缓存,web缓存,redis…… 你所能想到的各种包罗万象存在的打着缓存旗号存在的各种技术或者实现,无非都是宣扬缓...

17310
来自专栏Java帮帮-微信公众号-技术文章全总结

JSP与EL表达式重点学习笔记(1)

Jsp&el表达式 JSP指令 ? JSP指令概述 JSP指令的格式:<%@指令名 attr1=”” attr2=”” %>,一般都会把JSP指令放到JSP文件...

3349
来自专栏李家的小酒馆

Java面试基本知识

Java基本知识 基本知识 服务器:Tomcat 支持Servlet jsp JBoss 开源应用服务器 Apache:最广泛的http服务器,只支持静态网页 ...

1870
来自专栏JackieZheng

Spring实战——缓存

缓存 提到缓存,你能想到什么?一级缓存,二级缓存,web缓存,redis…… 你所能想到的各种包罗万象存在的打着缓存旗号存在的各种技术或者实现,无非都是宣扬缓...

16410
来自专栏企鹅号快讯

每日一学之socket编程(三)

图片来自于百度图片 NIO的新特性Buffer 前两期我们主要讲述了关于socket连接的问题,这期我们主要说说数据的问题。 自JDK1.4开始,Java提出了...

1639
来自专栏Java进阶

volatile和synchronized 实现原理的差别

2897
来自专栏orientlu

FreeRTOS 信号量

FreeRTOS 信号量和互斥锁是基于队列实现的, 队列介绍见 << FreeRTOS 消息队列 >>。 使用信号量需要在源文件中包含头文件 semphr....

572
来自专栏大内老A

深入探讨ASP.NET MVC的筛选器

在ActionInvoker对Action的执行过程中,除了通过利用ActionDescriptor对Action方法的执行,以及之前进行的Model绑定与验证...

1628
来自专栏我就是马云飞

设计模式二十四章经之责任链模式

1023
来自专栏后端之路

J2Cache二级缓存'没有自动更新'

在给组内小伙伴们做完二级缓存的普及关于两级缓存的说明后,组内小伙伴使用二级缓存开发了公告功能。 功能如下: <cache name="notice" ...

1867

扫描关注云+社区