Fewbit.EntityFramework.CrudApi 1.0.0-alpha-8

EntityFramework.CrudApi

The "EntityFramework.CrudApi" project is a library that enables the easy exposure of an Entity Framework DbContext as a REST API, all with just a single line of code. Leveraging the capabilities of the Minimal API approach in DotNet Core, it uses reflection to dynamically create and expose REST resources (GET, PUT, POST, DELETE) for each Entity/Class mapped through Entity Framework. This approach streamlines the process of creating REST endpoints, requiring only a few lines of code.

Features

• Minimal API Integration: The library seamlessly integrates with DotNet Core's Minimal API approach, providing a straightforward way to expose Entity Framework DbContext as RESTful endpoints.

• Reflection-based Resource Creation: Through reflection, the library dynamically generates REST resources for each Entity/Class mapped using Entity Framework. This eliminates the need for manually defining endpoints, making the process more efficient.

• Support for CRUD Operations: The generated API supports standard CRUD operations - GET, PUT, POST, and DELETE, allowing for easy manipulation of data stored in the underlying DbContext.

• Simplified Endpoint Creation: With just a single line of code, developers can expose an entire DbContext through REST APIs, significantly reducing the amount of boilerplate code required.

Getting Started

Installation

To use the "EntityFramework.CrudApi" library, you can install it via NuGet Package Manager:

dotnet add package Fewbit.EntityFramework.CrudApi --version 1.0.0-alpha

Usage

• Add a reference to the library in your project.

• In your startup or configuration code, include the following line to expose your DbContext through REST APIs:

// Before build app
builder.Services.AddEntityFrameworkCrudApi(typeof(Program).Assembly);


// After app was built
app.MapCrudApiRoutes<MyDbContext>().WithOpenApi();

• Replace MyDbContext with the name of your Entity Framework DbContext.

• That's it! Your DbContext is now accessible through REST endpoints.

Example

var builder = WebApplication.CreateBuilder(args);

builder.Logging.AddConsole();

builder.Services.Configure<JsonOptions>(options =>
{
    options.SerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles;
});

// Add DbContext
builder.Services.AddDbContext<MyDbContext>();

// Add Validators
builder.Services.AddValidatorsFromAssemblyContaining<Program>();

// Add AutoMapper
builder.Services.AddAutoMapper(typeof(Program));

// Add MediatR
builder.Services.AddMediatR(cfg => cfg.RegisterServicesFromAssemblyContaining<Program>());

// Customize CrudApi

// Add CrudApi
builder.Services.AddEntityFrameworkCrudApi(typeof(Program).Assembly);

// Add Problems mapping for error output
builder.Services.AddProblemDetails();

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

var app = builder.Build();

using (var scope = app.Services.CreateScope())
{
    var db = scope.ServiceProvider.GetRequiredService<MyDbContext>();
    db.Database.EnsureCreated();
}

// ConfigureRouteHandlerBuilder the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}
else
{
    app.UseExceptionHandler();
}

app.UseHttpsRedirection();

app.MapCrudApiRoutes<MovieStore>().WithOpenApi();

app.Run();