OData C#（開発者向けの仕組み）

ASP.NET Core アプリケーションでシンプルな OData モデル クラスを作成しましょう。 以下のコードでは、OData 構文を使用してクエリ可能なサービスのリストを公開します。

public class Service
{
    public int Id { get; set; } 
    public string FirstName { get; set; }
    public decimal Price { get; set; }
}

public class Service
{
    public int Id { get; set; } 
    public string FirstName { get; set; }
    public decimal Price { get; set; }
}

コードの説明

Service クラスは、 C# でサービスを管理するための基本的なデータ構造を表します。このクラスには3つのプロパティが含まれます。Id: サービスの整数識別子。FirstName: サービスに関連付けられた名を表す文字列。Price :サービスの価格を示す小数値。このクラスは、 .NET開発において、より複雑なサービス関連機能を作成するための構成要素として使用できます。 シナリオに基づいてコレクションまたはナビゲーションプロパティを使用することもできます。

Visual Studio の ASP.NET Core アプリケーションで、標準化された OData エンドポイントを介してサービスのリストを公開する OData コントローラーを設定する方法を以下に示します。 以下の例は、サービスの静的リストを使用した基本的な実装と、Web API で OData クエリ機能を有効にする方法を示します。

using DemoOData.Models;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.OData.Query;
using Microsoft.AspNetCore.OData.Routing.Controllers;

namespace DemoOData.Controllers
{
    [Route("odata/[controller]")]
    public class ServiceController : ODataController
    {
        private static readonly List<Service> Products = new List<Service>
        {
            new Service { Id = 1, FirstName = "Laptop", Price = 6239.9M },
            new Service { Id = 2, FirstName = "Smartphone", Price = 2585.9M }
        };

        [HttpGet]
        [EnableQuery]
        public IActionResult Get() => Ok(Products);
    }
}

using DemoOData.Models;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.OData.Query;
using Microsoft.AspNetCore.OData.Routing.Controllers;

namespace DemoOData.Controllers
{
    [Route("odata/[controller]")]
    public class ServiceController : ODataController
    {
        private static readonly List<Service> Products = new List<Service>
        {
            new Service { Id = 1, FirstName = "Laptop", Price = 6239.9M },
            new Service { Id = 2, FirstName = "Smartphone", Price = 2585.9M }
        };

        [HttpGet]
        [EnableQuery]
        public IActionResult Get() => Ok(Products);
    }
}

コードの説明

提供されたコードは、 ASP.NET Coreアプリケーションで ServiceController という名前の ODataController を定義し、OData プロトコルを使用してデータのクエリと操作を可能にします。 リクエストを odata/Service にルーティングし、ラップトップやスマートフォンなどの Service オブジェクトの静的リストを提供します。 Get メソッドは、[EnableQuery] で装飾されており、クライアントが製品リストに対して OData クエリ (フィルタリング、並べ替え、ページング) を実行し、結果を HTTP GET 要求の IActionResult として返すことを可能にします。

Program.cs 内で OData サービスを登録します

.NET 6 アプリケーションに OData を統合するためには、必要な OData パッケージをインストールして構成する必要があります。 これには、OData モデルの定義、OData ミドルウェアの設定、フィルタリング、順序設定、展開などの OData 機能をサポートするためのサービスの設定が含まれます。

using DemoOData.Models;
using Microsoft.AspNetCore.OData;
using Microsoft.OData.Edm;
using Microsoft.OData.ModelBuilder;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

static IEdmModel GetEdmModel()
{
    ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
    builder.EntitySet<Service>("Services");
    return builder.GetEdmModel();
}

builder.Services.AddControllers()
    .AddOData(options => options
        .AddRouteComponents("odata", GetEdmModel())
        .Select()
        .Filter()
        .OrderBy()
        .SetMaxTop(20)
        .Count()
        .Expand()
    );

using DemoOData.Models;
using Microsoft.AspNetCore.OData;
using Microsoft.OData.Edm;
using Microsoft.OData.ModelBuilder;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

static IEdmModel GetEdmModel()
{
    ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
    builder.EntitySet<Service>("Services");
    return builder.GetEdmModel();
}

builder.Services.AddControllers()
    .AddOData(options => options
        .AddRouteComponents("odata", GetEdmModel())
        .Select()
        .Filter()
        .OrderBy()
        .SetMaxTop(20)
        .Count()
        .Expand()
    );

コードの説明

このコードは、.NET 6 アプリケーションでの OData サポートを構成します。 まず、必要な名前空間をインポートし、WebApplicationBuilder インスタンスを作成します。 GetEdmModel メソッドは、ODataConventionModelBuilder を使用して OData モデルを定義します。これは、Service エンティティのエンティティ セットを指定します。 次に、AddOData メソッドが呼び出され、選択、フィルター、並べ替え、カウント、展開の有効化や、クエリ結果の最大値 20 の設定など、OData サービスが構成されます。 このセットアップにより、アプリケーションは効果的に OData クエリを処理できるようになります。

AddOData() メソッドは、クエリに使用されるデータモデルを取得し、OData サービスの基盤を形成する GetEdmModel() メソッドを採用しています。このサービスは、エンティティ データ モデル (EDM) と呼ばれる抽象データ モデルを使用して、公開されるデータを定義します。 ODataConventionModelBuilder クラスは、デフォルトの命名規則を使用して EDM を生成し、コード要件を最小限に抑えます。 あるいは、開発者は、EDM をより細かく制御するために、ODataModelBuilder クラスを利用することもできます。

コードのスクリーンショット