Skip to main content

A CRUD Operation Demo On Asp.NetCore Minimal Web API[Asp.NetCore 6.0 Feature]

Minimal API:

The concept of creating an HTTP API with minimal dependencies is Minimal APIs. It was introduced in Asp.Net 6, and they are ideal for microservices that can be finished with minimum files and features.

In Minimal API there won't be any controller or action methods. In Minimal API, the logical execution function will be registered along with the route registration.

On comparing Minimal API with the normal Web API, that Minimal API doesn't support(for Asp.Net Core 6  these won't support but in the upcoming versions, these may be available) the following features like:

  • Minimal API doesn't support built-in validation.
  • Minimal API doesn't support filters.
  • Minimal API doesn't support versioning.
  • Minimal API doesn't support OData.

Create A .Net6 Minimal API Project:

Let's create a .Net6 Minimal API sample project to accomplish our CRUD sample. We can use either Visual Studio 2022 or Visual Studio Code (using .NET CLI commands) to create any .Net6 application. For this demo, I'm using the 'Visual Studio Code'(Using .Net CLI commands) editor.

CLI command For Minimal API Project
dotnet new webapi -minimal -o Your_Project_Name


From .Net6 onwards there will be no 'Startup.cs' file, so all registration configurations moved to the 'Program.cs' file. Now on creating the Minimal API project, we will get the 'WeatherForeCaste' test endpoint so let's remove all its references, and finally our 'Program.cs' file looks as below.
Program.cs:
var builder = WebApplication.CreateBuilder(args);

// 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();

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

app.UseHttpsRedirection();

app.Run();
Since the concept of Minimal API is to use a minimum number of files. Now in this demo, we are going to use 'Program.cs' file to write our business logic and database logic inside it.

Configure EntityFramework Core DbContext:

Let's install the entity framework core NuGet.
Package Manager:
Install-Package Microsoft.EntityFrameworkCore -Version 6.0.0

.Net CLI:
dotnet add package Microsoft.EntityFrameworkCore --version 6.0.0

Let's install the SQLServer dependent library of entity framework core NuGet.
Package Manager:
Install-Package Microsoft.EntityFrameworkCore.SqlServer -Version 6.0.0

.Net CLI:
dotnet add package Microsoft.EntityFrameworkCore.SqlServer --version 6.0.0

Let's add the 'DbContext' at the end of the 'Program.cs' file.
Program.cs:
// Dbcontext
public class MyWorldDbContext:DbContext
{
    public MyWorldDbContext(DbContextOptions<MyWorldDbContext> options):base(options)
    {
        
    }
    public DbSet<Gadgets> Gadgets { get; set; }
}

// Database classes
public class Gadgets
{
    public int Id { get; set; }
    public string ProductName { get; set; }
    public string Brand { get; set; }
    public decimal Cost { get; set; }
    public string Type { get; set; }
}
Now register the 'AddDbContext' service.
Program.cs:
builder.Services.AddDbContext<MyWorldDbContext>(options =>
{
    options.UseSqlServer(builder.Configuration.GetConnectionString("MyWorldDbConnection"));
});

Endpoint HTTP Methods:

In the Minimal API, execution logic will be registered along with the endpoint URL. Each endpoint can be registered with the appropriate HTTP method.

Get:
app.MapGet("", () => {});
Post:
app.MapPost("", () => {});
Put:
app.MapPut("", () => {});
Delete:
app.MapDelete("", () => {});

Create Operation:

Let's implement the 'Create' operation endpoint for our Minimal API. let's begin adding our Endpoint Http Methods after the 'app.UseHttpsRedirection()' middleware.
Program.cs:
app.MapPost("/gadgets/create", async(Gadgets gadgets, MyWorldDbContext myWorldDb) => {
    myWorldDb.Gadgets.Add(gadgets);
    await myWorldDb.SaveChangesAsync();
    return Results.Ok();
});
  • (Line: 1) The 'MapPost' to create the HTTP Post endpoint. This method takes 2 input parameters where the 1st parameter is 'URL' and 2nd parameter is the delegate function that contains all execution logic of our Minimal API.
  • The Delegate handler we created as an asynchronous method. This Delegate handler is a custom method and here passes parameters like 1st parameter like payload of type 'Gadgets' and 2nd parameter is injected 'DatabaseContext'.
  • (Line: 2-3) Logic to save data to the database.
  • (Line: 4) Returning 'Ok' API response.

Read Operation:

Let's implement the 'Read' operation endpoint.
Program.cs:
app.MapGet("/gadgets", async (MyWorldDbContext myWorldDb) =>
{
    var gadgets = await myWorldDb.Gadgets.ToListAsync();
    return Results.Ok(gadgets);
});
  • (Line: 1) The 'MapGet' method represents HTTP get endpoint. The 'MapGet' method has 2 parameters like 1st parameter is 'URL' and 2nd parameter is 'Delegate'.
  • The 'Delegate' is implemented as an asynchronous method. Injected 'DatabaseContext' as an input parameter.
  • (Line: 3-4) Logic to fetching the collection of records from the database.

Update Operation:

Let's implement the 'Update' operation endpoint.
Program.cs:
app.MapPut("/gadets/update", async (Gadgets gadgetToUpdate, MyWorldDbContext myWorldDbContext) =>
{
    var dbGadget = await myWorldDbContext.Gadgets.FindAsync(gadgetToUpdate.Id);
    if (dbGadget == null)
    {
        return Results.NotFound();
    }
    dbGadget.Brand = gadgetToUpdate.Brand;
    dbGadget.Cost = gadgetToUpdate.Cost;
    dbGadget.ProductName = gadgetToUpdate.ProductName;
    dbGadget.Type = gadgetToUpdate.Type;
    await myWorldDbContext.SaveChangesAsync();
    return Results.NoContent();
});
  • (Line: 1) The 'MapPut' method represents the HTTP Put endpoint. The 'MapPut' method has 2 parameters like 1st parameter is 'URL' and 2nd parameter is the 'Delegate'. Here implemented Delegate as an asynchronous method that has 2 input parameters like 1st parameter payload to be updated and 2nd parameter injected the 'DatabaseContext'.
  • (Line: 3) Fetching the existing data from the database.
  • (Line: 4-7) Checking record trying to update is valid or not.
  • (Line: 8-13) Updating and saving the record into the table.

Delete Operation:

Let's implement the 'Delete' operation endpoint.
Program.cs:
app.MapDelete("/gadgets/delete/{id}", async (int id, MyWorldDbContext myWorldDbContext) =>
{
    var dbGadgets = await myWorldDbContext.Gadgets.FindAsync(id);
    if (dbGadgets == null)
    {
        return Results.NoContent();
    }
    myWorldDbContext.Gadgets.Remove(dbGadgets);
    await myWorldDbContext.SaveChangesAsync();
    return Results.Ok();
});
  • (Line: 1) The 'MapDelete' method represents the HTTP Delete endpoint. The 'MapDelete' method has 2 input parameters like 1st parameter is 'URL' and 2nd parameter is Delegate. Inside URL we can pass dynamic values with the '{}' expression, these values can be read into the Delegate handler method as input parameters.
  • (Line: 3-7) Fetching the record that needs to be deleted.
  • (Line: 8-10) Deleting the record from the database.

Finally, our entire Minimal API looks as below:
Program.cs:
using Microsoft.EntityFrameworkCore;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
builder.Services.AddDbContext<MyWorldDbContext>(options =>
{
    options.UseSqlServer(builder.Configuration.GetConnectionString("MyWorldDbConnection"));
});

var app = builder.Build();

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

app.UseHttpsRedirection();
// get endpoint
app.MapGet("/gadgets", async (MyWorldDbContext myWorldDb) =>
{
    var gadgets = await myWorldDb.Gadgets.ToListAsync();
    return Results.Ok(gadgets);
});
// post endpoint
app.MapPost("/gadgets/create", async (Gadgets gadgets, MyWorldDbContext myWorldDb) =>
{
    myWorldDb.Gadgets.Add(gadgets);
    await myWorldDb.SaveChangesAsync();
    return Results.Ok();
});
// update endpoint
app.MapPut("/gadets/update", async (Gadgets gadgetToUpdate, MyWorldDbContext myWorldDbContext) =>
{
    var dbGadget = await myWorldDbContext.Gadgets.FindAsync(gadgetToUpdate.Id);
    if (dbGadget == null)
    {
        return Results.NotFound();
    }
    dbGadget.Brand = gadgetToUpdate.Brand;
    dbGadget.Cost = gadgetToUpdate.Cost;
    dbGadget.ProductName = gadgetToUpdate.ProductName;
    dbGadget.Type = gadgetToUpdate.Type;
    await myWorldDbContext.SaveChangesAsync();
    return Results.NoContent();
});
// delete endpoint.
app.MapDelete("/gadgets/delete/{id}", async (int id, MyWorldDbContext myWorldDbContext) =>
{
    var dbGadgets = await myWorldDbContext.Gadgets.FindAsync(id);
    if (dbGadgets == null)
    {
        return Results.NoContent();
    }
    myWorldDbContext.Gadgets.Remove(dbGadgets);
    await myWorldDbContext.SaveChangesAsync();
    return Results.Ok();
});


app.Run();

// Dbcontext
public class MyWorldDbContext : DbContext
{
    public MyWorldDbContext(DbContextOptions<MyWorldDbContext> options) : base(options)
    {

    }
    public DbSet<Gadgets> Gadgets { get; set; }
}

// Database classes
public class Gadgets
{
    public int Id { get; set; }
    public string ProductName { get; set; }
    public string Brand { get; set; }
    public decimal Cost { get; set; }
    public string Type { get; set; }
}

Support Me!
Buy Me A Coffee PayPal Me

Video Session:

Wrapping Up:

Hopefully, I think this article delivered some useful information on Minimal API CRUD Operations in .Net6 Application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

Popular posts from this blog

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

NestJS File Upload

In this article, we are going to understand the steps to create a file uploading endpoint in the NestJS application. Key Features In NestJS File Upload: Let us know some key features of NestJS file upload before implementing a sample application. FileInterceptor: The 'FileInterceptor' will be decorated on top of the file upload endpoint. This interceptor will read single file data from the form posted to the endpoint. export declare function FilesInterceptor(fieldName: string, localOptions?: MulterOptions): Type<NestInterceptor>; Here we can observe the 'fieldName' first input parameter this value should be a match with our 'name' attribute value on the form file input field. So our interceptor read our files that are attached to the file input field. Another input parameter of 'MulterOptions' that provides configuration like file destination path, customizing file name, etc. FilesInterceptor: The 'FilesInterceptor' will be decorated on t

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http