OData查询Restful API

时间:2022-06-03 Upgrader 人气:5

前言：

本文使用 .NET Core SDK 3.1 的版本。

OData 是 Open Data Protocol 的简写，

OData 允许以简单和标准的方式创建和使用可查询和互操作的 Restful API。

创建 Web API 项目，并引入 OData 相关的 NuGet 包：

dotnet pack Microsoft.AspNetCore.OData -v 7.5.8

一、建构 OData 实体模型

在建构 OData 实体模型之前，需要先创建相关的 DTO

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

随后建构 OData 实体模型

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

二、配置 OData 中间件

配置 OData 服务

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

配置 OData 中间件

    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());
        });
    }

三、OData 实现 Restful API 查询

创建一个 PersonController 控制器，并继承 ODataController。

给 Action 的特性增加上 [EnableQuery] 来表示当前 API 是 OData 协议的方法，

在 Action 的入参加上特性 [FromODataUri] 来表示当前入参来自 OData 格式的 Uri 中。

    public class PersonController : ODataController
    {
        private static readonly List<Person> PEOPLE = new List<Person>
        {
            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));
        }
    }

通过下面 Uri 访问查询全部数据的 API，

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

我们先看结果，我们可以得到如下 JSON

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

得到的结果不难看出，OData 查询 API 的 Uri 通过 $ 符号起始的参数来对 Action 返回的结果进行改造，进行排序，字段的筛选等等功能。
我们访问 @odata.context 参数的 Value 这个 Uri，我们可以看到该接口相关实体的详细详细。

通过下面 Uri 访问查询某条数据的 API，

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

我们可以得到如下 JSON

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

参考文档

OData - Basic Tutorial

加载全部内容