ASP.NET?Core怎么構建OData查詢Restful?API

這篇文章主要講解了“ASP.NET Core怎么構建OData查詢Restful API”，文中的講解內容簡單清晰，易于學習與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學習“ASP.NET Core怎么構建OData查詢Restful API”吧！

前言：

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

OData 是 Open Data Protocol 的簡寫，

OData 允許以簡單和標準的方式創建和使用可查詢和互操作的 Restful API。

官方文檔訪問 OData - Basic Tutorial

創建 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
  }

感謝各位的閱讀，以上就是“ASP.NET Core怎么構建OData查詢Restful API”的內容了，經過本文的學習后，相信大家對ASP.NET Core怎么構建OData查詢Restful API這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是億速云，小編將為大家推送更多相關知識點的文章，歡迎關注！