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

 

转载于:https://www.cnblogs.com/hdwgxz/p/7856394.html