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方式。
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- PHP删除字符串中非字母数字字符方法总结
- 实例讲解php将字符串输出到HTML
- PHP的mysqli_stat()函数讲解
- php中访问修饰符的知识点总结
- 浅谈keras 模型用于预测时的注意事项
- 使用Keras预训练好的模型进行目标类别预测详解
- keras输出预测值和真实值方式
- 对python pandas中 inplace 参数的理解
- PHP基于GD2函数库实现验证码功能示例
- PHP合并两个或多个数组的方法
- PHP的mysqli_set_charset()函数讲解
- PHP常见加密函数用法示例【crypt与md5】
- PHP的mysqli_sqlstate()函数讲解
- PHP Laravel中的Trait使用方法
- PHP CURL使用详解