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

IRON VB CONVERTER ERROR developers@ironsoftware.com

コードの説明

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

Imports DemoOData.Models
Imports Microsoft.AspNetCore.Mvc
Imports Microsoft.AspNetCore.OData.Query
Imports Microsoft.AspNetCore.OData.Routing.Controllers

Namespace DemoOData.Controllers
	<Route("odata/[controller]")>
	Public Class ServiceController
		Inherits ODataController

		Private Shared ReadOnly Products As New List(Of Service) From {
			New Service With {
				.Id = 1,
				.FirstName = "Laptop",
				.Price = 6239.9D
			},
			New Service With {
				.Id = 2,
				.FirstName = "Smartphone",
				.Price = 2585.9D
			}
		}

		<HttpGet>
		<EnableQuery>
		Public Function [Get]() As IActionResult
			Return Ok(Products)
		End Function
	End Class
End Namespace

コードの説明

提供されたコードは、ASP.NET Core アプリケーションでデータを OData プロトコルを使用してクエリおよび操作する ODataController 名の ServiceController を定義します。 これは、リクエストを odata/Service にルーティングし、静的な Service オブジェクト（ラップトップとスマートフォンを含む）のリストを提供します。 [EnableQuery] でデコレートされた Get メソッドは、クライアントが製品リストに対して 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()
    );

Imports DemoOData.Models
Imports Microsoft.AspNetCore.OData
Imports Microsoft.OData.Edm
Imports Microsoft.OData.ModelBuilder

Private 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()

'INSTANT VB TODO TASK: Local functions are not converted by Instant VB:
'static IEdmModel GetEdmModel()
'{
'	ODataConventionModelBuilder builder = New ODataConventionModelBuilder();
'	builder.EntitySet<Service>("Services");
'	Return builder.GetEdmModel();
'}

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

コードの説明

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

AddOData() メソッドは GetEdmModel() メソッドを利用し、クエリに使用されるデータモデルを取得し、OData サービスの基盤を形成します。このサービスは、公開されたデータを定義するための抽象データモデルである Entity Data Model (EDM) を利用します。 ODataConventionModelBuilder クラスは、デフォルトの命名規則を通じて EDM を生成し、コード要件を最小限に抑えます。 代替として、開発者は ODataModelBuilder クラスを使用して EDM をより手動で制御することができます。

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