ASP.NET Core构建OData查询Restful API_实用技巧_

dotnet pack Microsoft.AspNetCore.OData -v 7.5.8

 public class Person { public int Id { get; set; } public string Name { get; set; } public int Age { get; set; } } 

 public static class PersonModelBuilder { public static IEdmModel GetEdmModel() { var oDataBuilder = new ODataConventionModelBuilder(); oDataBuilder.EntitySet("Person"); return oDataBuilder.GetEdmModel(); } } 

 public void ConfigureServices(IServiceCollection services) { // ...... services.AddOData(); } 

 public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { app.UseRouting(); app.UseEndpoints(endpoints => { endpoints.Select().Filter().OrderBy().Count().MaxTop(10); // 第一个参数 路由名称，第二个参数 路由前缀，第三个参数 创建OData实体数据模型的方法 // 通过这个方式创建了与OData相关联的路由 endpoints.MapODataRoute("odata", "odata", PersonModelBuilder.GetEdmModel()); }); } 

 public class PersonController : ODataController { private static readonly List PEOPLE = new List { new Person { Id = 1, Name = "张三", Age = 18 }, new Person { Id = 2, Name = "李四", Age = 19 }, new Person { Id = 3, Name = "王五", Age = 20 }, new Person { Id = 4, Name = "赵六", Age = 21 }, }; [HttpGet, EnableQuery] public ActionResult Get() { var people = PEOPLE; return Ok(people); } [HttpGet, EnableQuery] public IActionResult Get([FromODataUri] int key) { var people = PEOPLE; return Ok(people.FirstOrDefault(b => b.Id == key)); } } 

 http://localhost:5000/odata/person?$select=name,age&$orderby=age desc&$count=true&$top=2&$skip=2

 { "@odata.context": "http://localhost:5000/odata/$metadata#Person(Name,Age)", "@odata.count": 4, "value": [ { "Name": "李四", "Age": 19 }, { "Name": "张三", "Age": 18 } ] } 

http://localhost:5000/odata/person(1)

 { "@odata.context": "http://localhost:5000/odata/$metadata#Person/$entity", "Id": 1, "Name": "张三", "Age": 18 }