MongoDBと Entity Framework および ASP .NET Core を統合

Overview

このガイドでは、OData エンドポイントを提供し、Entity Framework（FS）コアプロバイダーを使用してMongoDBにアクセスする ASP .NET Coreアプリケーションを作成する方法を学習できます。 ASP .NET Core は、クラウドベースのアプリケーションを作成するためのクロスプラットフォームフレームワークです。 OData は、RESTul API をビルドして消費するための標準化されたプロトコルであり、 HTTPリクエストを使用してデータをやり取りできます。

このチュートリアルのアプリケーションは、次のレイヤーで構成されています。

データベースレイヤー: MongoDB は、データのストレージと検索を提供します。
アプリケーションレイヤー: ASP .NET Core は、 HTTPリクエスト、ルーティング、依存関係インジェクションを処理します。
データアクセスレイヤー: FS コアプロバイダーは、 MongoDBドキュメントマッピングと OData クエリの変換を提供します。

ASP .NET Core と OData でMongoDBを使用する理由

このチュートリアルでは、ASP .NET Core ODataフレームワークとMongoDB用の Entity Framework（FS）コアプロバイダーを使用して、クエリ可能な REST API を作成します。 OData は、データを公開してやり取りする統一された方法を提供し、フィルタリング、ソート、ページング、フィールド選択などの高度なクエリ機能を提供します。

MongoDB ：この組み合わせは、複雑なクエリインターフェース、型の安全性、標準ベースのAPI設計を必要とするアプリケーションをサポートします。 MongoDB、 ASP .NET Core、OData を使用して、データ分析ダッシュボード、レポート作成システム、複雑なデータクエリを必要とするアプリケーションなどの本番環境のアプリケーションを作成できます。

クイックスタートチュートリアル

このチュートリアルでは、 MongoDB、ASP .NET Core、およびLF Core プロバイダーを使用する OData REST APIを構築する方法について説明します。このアプリケーションは、サンプルレストランデータにアクセスし、OData 準拠のエンドポイントを公開し、フィルタリング、ソート、ページング、フィールド選択などの高度なクエリ機能をサポートします。チュートリアルには、 MongoDB AtlasでホストされているMongoDBクラスターに接続するための手順も含まれています。

Tip

ASP .NET Core を使用せずに FS Core プロバイダーを使用してMongoDBに接続する場合は、 Entity Framework プロバイダーのクイックスタートチュートリアルを参照してください。

プロジェクトを設定する

このセクションの手順に従って、プロジェクトの依存関係のインストール、Atlas クラスターの作成、およびアプリケーション構造の設定を行います。

前提条件を確認します。

クイックスタートアプリケーションを作成するには、開発環境に次のソフトウェアをインストールします。

前提条件	ノート
.NET SDK	.NET 8.0 以降をインストールします。
コードエディター	お好みのコードエディターを使用してください。
ターミナルアプリとシェル	Windowsユーザーの場合は、 PowerShell またはコマンドプロンプトを使用します。 macOS/ Linuxユーザーの場合は、ターミナルまたは類似アプリを使用します。

MongoDB Atlasクラスターを作成します。

MongoDB Atlas は、 MongoDB配置をホストするフルマネージドクラウドデータベースサービスです。 MongoDBデプロイがない場合は、 MongoDBを使い始めるチュートリアルを完了することで、 MongoDBクラスターを無料で作成できます。 MongoDBを使い始めるsample_restaurants チュートリアルでは、このチュートリアルで使用されるデータベースなどのサンプルデータセットをクラスターにロードする方法も説明します。

MongoDBクラスターに接続するには、接続文字列を使用する必要があります。接続文字列を取得する方法については、 MongoDBを使い始めるチュートリアルの「接続文字列列の追加」セクションを参照してください。

重要

接続stringを安全な場所に保存します。

ASP .NET Coreプロジェクトを作成します。

ターミナルから次のコマンドを実行して、RestaurantODataApi という名前の新しい ASP .NET Core Web APIプロジェクトを作成します。

dotnet new webapi -n RestaurantODataApi
cd RestaurantODataApi

必要な依存関係を追加します。

RestaurantODataApiディレクトリで、次のコマンドを実行して必要な NuGet パッケージを追加します。

dotnet add package MongoDB.EntityFrameworkCore
dotnet add package Microsoft.AspNetCore.OData

これらのコマンドは、次のパッケージをインストールします。

MongoDB.EntityFrameworkCore: MongoDB FS コアプロバイダー
Microsoft.AspNetCore.OData: ASP .NET Core の OData サポート

データベース接続を構成します。

RestaurantODataApiプロジェクト内の appsettings.jsonファイルに移動し、次のコードを貼り付けます。

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
  "MongoDB": {
    "ConnectionString": "<connection string>",
    "DatabaseName": "sample_restaurants"
  }
}

<connection string> プレースホルダーを、 MongoDBを使い始めるチュートリアルから保存した接続文字列に置き換えます。

アプリケーションを作成する

プロジェクト構造と依存関係を設定したら、このセクションの手順に従って、データモデル、DbContext、OData エンドポイントを作成します。

データモデルを作成します。

RestaurantODataApiディレクトリに、Models サブディレクトリを作成します。次に、Modelsディレクトリに Restaurant.cs という名前のファイルを作成し、次のコードを追加します。

restaurantODataApi/models/Restaurant.cs

using Microsoft.EntityFrameworkCore;
using MongoDB.Bson;
using MongoDB.Bson.Serialization.Attributes;
using System.ComponentModel.DataAnnotations;
namespace RestaurantODataApi.Models
{
    public class Restaurant
    {
        [Key]
        [BsonId]
        [BsonRepresentation(BsonType.ObjectId)]
        public string Id { get; set; } = string.Empty;
        [BsonElement("name")]
        public string? Name { get; set; }
        [BsonElement("cuisine")]
        public string? Cuisine { get; set; }
        [BsonElement("borough")]
        public string? Borough { get; set; }
    }
}

このモデルクラスは、 MongoDB sample_restaurants.restaurantsコレクションのレストランデータの構造を定義し、 Entity Framework とMongoDB直列化属性を含みます。

データベース接続を構成します。

RestaurantODataApiディレクトリに、RestaurantDbContext.cs という名前のファイルを作成し、次のコードを追加します。

restaurantODataApi/RestaurantDbContext.cs

using Microsoft.EntityFrameworkCore;
using MongoDB.Driver;
using MongoDB.EntityFrameworkCore.Extensions;
using RestaurantODataApi.Models;
namespace RestaurantODataApi
{
    public class RestaurantDbContext : DbContext
    {
        public DbSet<Restaurant> Restaurants { get; set; }
        public RestaurantDbContext(DbContextOptions<RestaurantDbContext> options)
            : base(options)
        {
        }
        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            base.OnModelCreating(modelBuilder);
            // Configures the Restaurant entity to map to the "restaurants" collection
            modelBuilder.Entity<Restaurant>().ToCollection("restaurants");
        }
    }
}

このクラスは、モデルと基礎となるデータベースの間の関係を構成する DBContext から派生します。このコードは、F をMongoDBで動作するように構成し、Restaurant エンティティをsample_restaurants.restaurants コレクションにマッピングします。

OData コントローラーを作成します。

RestaurantODataApiディレクトリに、Controllers サブディレクトリを作成します。次に、RestaurantsController.cs という名前のファイルをサブディレクトリに追加し、次のコードを貼り付けます。

restaurantODataApi/Clusters/Restaurants Controller.cs

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.OData.Query;
using Microsoft.AspNetCore.OData.Routing.Controllers;
using Microsoft.AspNetCore.OData.Routing.Attributes;
using RestaurantODataApi.Models;
namespace RestaurantODataApi.Controllers
{
    public class RestaurantsController : ODataController
    {
        private readonly RestaurantDbContext _context;
        public RestaurantsController(RestaurantDbContext context)
        {
            _context = context;
        }
        [EnableQuery(PageSize = 50, AllowedQueryOptions = AllowedQueryOptions.All)]
        public IQueryable<Restaurant> Get()
        {
            return _context.Restaurants;
        }
        [HttpGet("odata/GetRestaurantsByBorough(borough={borough})")]
        [EnableQuery(PageSize = 20)]
        public IQueryable<Restaurant> GetRestaurantsByBorough(string borough)
        {
            return _context.Restaurants.Where(r => r.Borough == borough);
        }
        [HttpGet("odata/GetRestaurantsByCuisine(cuisine={cuisine})")]
        [EnableQuery(PageSize = 20)]
        public IQueryable<Restaurant> GetRestaurantsByCuisine(string cuisine)
        {
            return _context.Restaurants.Where(r => r.Cuisine == cuisine);
        }
    }
}

このコントローラーは、次の OData REST エンドポイントを定義します。

GET /odata/Restaurants: restaurantsコレクション内のすべてのドキュメントを検索します。 EnableQuery 属性とその構成オプションを使用すると、 HTTPリクエストで $filter や $orderby などの OData クエリパラメータを使用できます。
GET /odata/GetRestaurantsByBorough(borough='{borough}'): 指定された borough 値を持つドキュメントを取得します。
GET /odata/GetRestaurantsByCuisine(cuisine='{cuisine}'): 指定された cuisine 値を持つドキュメントを取得します。

アプリケーションロジックを定義します。

Program.csファイルに移動し、その内容を次のコードで置き換えます。

restoreODataApi/Program.cs

using Microsoft.AspNetCore.OData;
using Microsoft.EntityFrameworkCore;
using Microsoft.OData.ModelBuilder;
using MongoDB.Driver;
using RestaurantODataApi;
using RestaurantODataApi.Models;
var builder = WebApplication.CreateBuilder(args);
// Configures the MongoDB connection
var connectionString = builder.Configuration["MongoDB:ConnectionString"];
var databaseName = builder.Configuration["MongoDB:DatabaseName"] ?? "sample_restaurants";
if (string.IsNullOrEmpty(connectionString))
{
    throw new InvalidOperationException("MongoDB connection string is required. Please set MongoDB:ConnectionString in appsettings.json");
}
// Registers a MongoDB client
builder.Services.AddSingleton<IMongoClient>(sp => new MongoClient(connectionString));
// Registers the DbContext
builder.Services.AddDbContext<RestaurantDbContext>(options =>
{
    var mongoClient = new MongoClient(connectionString);
    options.UseMongoDB(mongoClient, databaseName);
});
// Configures the OData EDM model
var modelBuilder = new ODataConventionModelBuilder();
modelBuilder.EntitySet<Restaurant>("Restaurants");
modelBuilder.EntityType<Restaurant>().HasKey(r => r.Id);
// Registers the unbound functions
var getRestaurantsByBoroughFunction = modelBuilder.Function("GetRestaurantsByBorough");
getRestaurantsByBoroughFunction.Parameter<string>("borough");
getRestaurantsByBoroughFunction.ReturnsCollectionFromEntitySet<Restaurant>("Restaurants");
var getRestaurantsByCuisineFunction = modelBuilder.Function("GetRestaurantsByCuisine");
getRestaurantsByCuisineFunction.Parameter<string>("cuisine");
getRestaurantsByCuisineFunction.ReturnsCollectionFromEntitySet<Restaurant>("Restaurants");
// Configures OData with ASP.NET Core
builder.Services.AddControllers()
    .AddOData(opt => opt
        .AddRouteComponents("odata", modelBuilder.GetEdmModel())
        .Select()
        .Filter()
        .OrderBy()
        .Expand()
        .Count()
        .SetMaxTop(100));
var app = builder.Build();
app.UseRouting();
app.MapControllers();
app.Run();

このコードは、 MongoDB接続、Entity Framework DbContext、OData サービスを設定します。 OData 構成コードにより、次のクエリパラメータが有効になり、 HTTPエンドポイントで使用できます。

$select: 結果内の指定されたフィールドを返します
$filter: フィルター条件に基づいてデータを返します
$orderby: 指定されたフィールドで結果をソートします
$expand: 結果に関連データを含める
$count: 結果のカウントを含めます
$top: 結果の最大数を設定します。 100

アプリケーションの実行

最後に、このセクションの手順に従ってOData REST APIを実行し、 HTTPリクエストを使用してエンドポイントをテストします。

ASP .NET Coreアプリケーションを起動します。

RestaurantODataApiディレクトリから、次のコマンドを実行してアプリケーションをコンパイルして起動します。

dotnet run

成功した場合、コマンド出力は次の例のようになります。

info: Microsoft.Hosting.Lifetime[14]
      Now listening on: http://localhost:5236
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.

OData エンドポイントをテストします。

別のターミナルで、次の curl コマンドを実行して、OData エンドポイントをテストします。各エンドポイントは、sample_restaurants.restaurantsコレクションのレストラン情報を含む OData形式のJSONデータを返します。成功した場合、curl コマンドはサンプル出力のようなデータを返します。コマンドは結果を 5 ドキュメントに制限します。

すべてのレストランを検索します。

curl 'http://localhost:5236/odata/Restaurants?$top=5'

{"@odata.context":"http://localhost:5236/odata/$metadata#Restaurants",
"value":[
   {"Id":"...","Name":"Riviera Caterer","Cuisine":
   "American","Borough":"Brooklyn","RestaurantId":"40356018"},
   {"Id":"...","Name":"Wilken'S Fine Food","Cuisine":
   "Delicatessen","Borough":"Brooklyn","RestaurantId":"40356483"},
   {"Id":"...","Name":"Kosher Island","Cuisine":
   "Jewish/Kosher","Borough":"Staten Island","RestaurantId":"40356442"},
   {"Id":"...","Name":"Wendy'S","Cuisine":"Hamburgers",
   "Borough":"Brooklyn","RestaurantId":"30112340"},
   {"Id":"...","Name":"Morris Park Bake Shop","Cuisine":
   "Bakery","Borough":"Bronx","RestaurantId":"30075445"}
]}

レストランを地区別にフィルタリングします。

次のコマンドは、borough 値が "Queens" であるレストランを検索します。

curl 'http://localhost:5236/odata/GetRestaurantsByBorough(borough=%27Queens%27)?$top=5'

{"@odata.context":"http://localhost:5236/odata/$metadata#Restaurants",
"value":[
   {"Id":"...","Name":"Tov Kosher Kitchen","Cuisine":"Jewish/Kosher",
   "Borough":"Queens","RestaurantId":"40356068"},
   {"Id":"...","Name":"Brunos On The Boulevard","Cuisine":"American",
   "Borough":"Queens","RestaurantId":"40356151"},
   {"Id":"...","Name":"Carvel Ice Cream","Cuisine":"Ice Cream, Gelato, Yogurt, Ices",
   "Borough":"Queens","RestaurantId":"40361322"},
   {"Id":"...","Name":"Sal'S Deli","Cuisine":"Delicatessen",
   "Borough":"Queens","RestaurantId":"40361618"},
   {"Id":"...","Name":"Steve Chu'S Deli & Grocery","Cuisine":"Delicatessen",
   "Borough":"Queens","RestaurantId":"40361998"}
]}

レストランを料理別にフィルタリングします。

次のコマンドは、cuisine 値が "Mexican" であるレストランを検索します。

curl 'http://localhost:5236/odata/GetRestaurantsByCuisine(cuisine=%27Mexican%27)?$top=5'

{"@odata.context":"http://localhost:5236/odata/$metadata#Restaurants",
"value":[
   {"Id":"...","Name":"Panchito'S","Cuisine":"Mexican","Borough":"Manhattan"},
   {"Id":"...","Name":"Mexico Lindo Restaurant","Cuisine":"Mexican","Borough":"Manhattan"},
   {"Id":"...","Name":"Casa Pepe","Cuisine":"Mexican","Borough":"Brooklyn"},
   {"Id":"...","Name":"Cuchifrito","Cuisine":"Mexican","Borough":"Manhattan"},
   {"Id":"...","Name":"Mary Ann'S","Cuisine":"Mexican","Borough":"Manhattan"}
]}

OData の高度なクエリ機能をテストします。

エンドポイントを使用して、OData クエリパラメーターと演算子を含めることで、複雑なクエリを実行できます。次の curl コマンドは、これらの機能をテストします。

複数のフィールドでフィルタリングします。

次のコマンドでは、OData クエリ演算子を使用して、borough 値が "Queens" で、かつ name 値が "Moon" を含むドキュメントを検索します。

curl 'http://localhost:5236/odata/Restaurants?$filter=Borough%20eq%20%27Queens%27%20and%20contains(Name,%20%27Moon%27)'

{"@odata.context":"http://localhost:5236/odata/$metadata#Restaurants",
"value":[
   {"Id":"...","Name":"New Moon Star Restaurant","Cuisine":"Chinese","Borough":"Queens"},
   {"Id":"...","Name":"Moon Tikka Grill","Cuisine":"Indian","Borough":"Queens"},
   {"Id":"...","Name":"Silver Moon Diner","Cuisine":"American","Borough":"Queens"},
   {"Id":"...","Name":"Mooney'S Public House","Cuisine":"Irish","Borough":"Queens"},
   {"Id":"...","Name":"Moon Light  Crill Rest","Cuisine":"Indian","Borough":"Queens"},
   {"Id":"...","Name":"Full Moon Cafe","Cuisine":"Café/Coffee/Tea","Borough":"Queens"},
   {"Id":"...","Name":"Pacific Moon","Cuisine":"Chinese","Borough":"Queens"},
   {"Id":"...","Name":"Moon Palace Kitchen","Cuisine":"Chinese","Borough":"Queens"},
   {"Id":"...","Name":"Honey Moon Coffee Shop","Cuisine":"Café/Coffee/Tea","Borough":"Queens"},
   {"Id":"...","Name":"Honey Moon Coffee Shop","Cuisine":"Café/Coffee/Tea","Borough":"Queens"}
   ]}%

結果を順序付けてカウントします。

次のコマンドは、cuisine フィルターに一致するドキュメントを name 値でソートし、一致するドキュメントの合計数をカウントします。

curl 'http://localhost:5236/odata/GetRestaurantsByCuisine(cuisine=%27Czech%27)?$orderby=Name&$count=true'

{"@odata.context":"http://localhost:5236/odata/$metadata#Restaurants",
"@odata.count":6,
"value":[
   {"Id":"...","Name":"Bohemian Beer Garden","Cuisine":"Czech","Borough":"Queens"},
   {"Id":"...","Name":"Brooklyn Beet Company","Cuisine":"Czech","Borough":"Brooklyn"},
   {"Id":"...","Name":"Hospoda","Cuisine":"Czech","Borough":"Manhattan"},
   {"Id":"...","Name":"Koliba Restaurant","Cuisine":"Czech","Borough":"Queens"},
   {"Id":"...","Name":"Milan'S Restaurant","Cuisine":"Czech","Borough":"Brooklyn"},
   {"Id":"...","Name":"Olde Prague Tavern","Cuisine":"Czech","Borough":"Queens"}
]}

FS、 ASP .NET 、 OData クイックスタートチュートリアルを完了しました。これらの手順を完了すると、 MongoDBデプロイに接続し、 OData エンドポイントを使用してレストランのデータを返し、フィルタリング、ソート、ページング、フィールド選択、検索などの高度なREST API機能をサポートする ASP .NET Core OData REST API が作成されます。

追加リソース

このチュートリアルで述べられた概念の詳細については、次のリソースを参照してください。

ASP .NET Core OData ドキュメント
OData Protocol のドキュメント
MongoDB Entity Framework コアプロバイダーのドキュメント
MongoDB C#ドライバーのドキュメント

戻る

互換性

Overview

ASP .NET Core と OData でMongoDBを使用する理由

クイック スタート チュートリアル

Tip

プロジェクトを設定する

前提条件を確認します。

MongoDB Atlasクラスターを作成します。

重要

ASP .NET Coreプロジェクトを作成します。

必要な依存関係を追加します。

データベース接続を構成します。

アプリケーションを作成する

データモデルを作成します。

データベース接続を構成します。

OData コントローラーを作成します。

アプリケーションロジックを定義します。

アプリケーションの実行

ASP .NET Coreアプリケーション を起動します。

OData エンドポイントをテストします。

OData の高度なクエリ機能をテストします。

追加リソース

クイックスタートチュートリアル

ASP .NET Coreアプリケーションを起動します。