Skip to main content

Part-3 A CRUD Operation Demo With .NET6 Web API | SQL Database | Angular13

The main objectives of this article are:
  • .NET6 Web API
  • Install .NET6 SDK
  • Create A .NET6 Web API Application.
  • Entity Framework Core
  • Install Entity Framework Core NuGet
  • SQL Connectionstring
  • Setup Entity Framework Core DatabaseContext.

.NET6 Web API:

Web API is a framework for building an HTTP service that can be accessed from any client like browser, mobile devices, and desktop apps.

In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients.

Some of the key characteristics of  API:
  • Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc.
  • Supports default responses like 'XML' and 'JSON'. Also can define custom responses.
  • Supports self-hosting or individual hosting, so that all different kinds of apps can consume it.
  • Authentication and Authorization are easy to implement.
  • The ideal platform to build REST full services.

Install .NET6 SDK:

Note: Install .NET6 SDK for .NET CLI users. For Visual Studio users no need to install it explicitly, just need to have Visual Studio 2022(only the latest version supports .NET6). To download the Visual Studio 2022 community version(free version) go to "https://visualstudio.microsoft.com/vs/".

Dotnet CLI users must install the .NET6 SDK, so go to 'https://dotnet.microsoft.com/en-us/download/dotnet/6.0' and then download the SDK with respect to your machine operating system.

Create A .NET6 Web API Application:

Let's create a .Net6 Web API sample application to accomplish our demo. 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 the .NET CLI command) editor.
CLI command
dotnet new webapi -o Your_Project_Name

Now let's explore default services or middleware that are in 'Program.cs':

Services in Program.cs:
builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
  • (Line:1) The 'AddControllers' service for API Controllers. This method will not work for the Views or Pages.
  • (Line: 2) The 'AddEndpointsApiExplorer' service for endpoint metadata.
  • (Line: 3) The 'AddSwagerGen' service for the Swagger.
Middlewares in Program.cs:
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}
app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();
  • (Line: 3-4) The swagger middleware to load the swagger page.
  • (Line: 6) The 'UseHttpsRedirection' middleware to redirect the 'HTTP' request to 'HTTPS'.
  • (Line: 7) The user authorization middleware.
  • (Line: 8) The 'MapControllers' is an endpoint middleware that can direct the request to API's controllers.

Entity FrameworkCore:

Entity Framework Core is an Object/Relational Mapping(ORM) framework. EF Core makes database communication more fluent and easy. The 'DatabaseContext' class acts as a database from our c# code, it will contain all registered tables as 'DbSet<TEntity>'(TEntity is any POCO class of a table).

In this demo, we are going to implement the 'Code First With Existing Database' technique. Creating the classes for an existing database is known as 'Code First With Existing Database'.

Install Entity FrameworkCore NuGet:

Now install the Entity Framework Core NuGet.
Package Manager Command
Install-Package Microsoft.EntityFrameworkCore -Version 6.0.4

CLI command
dotnet add package Microsoft.EntityFrameworkCore --version 6.0.4

Now install SQLServer which is Entity Framework Core dependent library.
Package Manager Command
Install-Package Microsoft.EntityFrameworkCore.SqlServer -Version 6.0.4

CLI command
dotnet add package Microsoft.EntityFrameworkCore.SqlServer --version 6.0.4

SQL Connectionstring:

Let's prepare an SQL server connectionsting.
Sample SQL Connectionstring:
Data Source=your_sql_server_name;Initial Catalog=your_database_name;Integrated Security=True;Connect Timeout=30
  • Data Source -  SQL Server Name.
  • Initial Catalog - Name of your database.
  • Integrated Security - Current windows credentials use for authentication.
  • Connect Timeout - SQL Connection Timeout.
Configure the connection string into our 'appsettings.Development.json' file.
appsettings.Development.json:
"ConnectionStrings": {
  "MyWorldDbConnection":"your_connection"
}

Setup Entity Framework Core DatabaseContext:

Let's create a class that represents our table 'Student'. So let's folder like 'Data' and a subfolder like 'Entities' and then add a class like 'Student.cs'.
Data/Entities/Student.cs:
namespace Student.Api.Data.Entities;

public class Student
{
    public int Id { get; set; }
    public string? Name { get; set; }
    public int Age { get; set; }
    public string? Gender { get; set; }
}

To manage or control all the table classes we have to create a database context class. So let's create our context class like 'MyWorldDbContext.cs' in the 'Data' folder.
using Microsoft.EntityFrameworkCore;

namespace  Student.Api.Data;

public class MyWorldDbContext : DbContext
{
    public MyWorldDbContext(DbContextOptions<MyWorldDbContext> options) : base(options)
    {
 
    }
    public DbSet<Student.Api.Data.Entities.Student> Student { get; set; }
}
  • (Line: 5) The 'Microsoft.EntityFrameworkCore.DbContext' needs to be inherited by our 'MyWorldDbContext' to act as a database context class.
  • (Line: 7) The 'Microsoft.EntityFrameworkCore.DbContextOptions' is instance of options that we are going to register in 'Program.cs' like 'ConnectionString', 'DatabaseProvider', etc.
  • (Line: 11) All our table classes must be registered inside of our database context class with 'DbSet<T>' so that the entity framework core can communicate with the tables of the database.
Register the Database Context service in the 'Program.cs' file for dependency injection.
Program.cs:
builder.Services.AddDbContext<MyWorldDbContext>(options =>
{
	options.UseSqlServer(builder.Configuration.GetConnectionString("MyWorldDbConnection"));
});
  • Here we have to pass our connection string to 'UseSqlServer()'.
In the next article, we are going to create an HTTP GET endpoint in our API and then consume that GET endpoint by our angular application and bind the response data to the bootstrap table.

Support Me!
Buy Me A Coffee PayPal Me

Video Session:

Wrapping Up:

Hopefully, I think this article delivered some useful demo on  .NET6 API and Angular application. using I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Comments

Popular posts from this blog

Angular 14 Reactive Forms Example

In this article, we will explore the Angular(14) reactive forms with an example. Reactive Forms: Angular reactive forms support model-driven techniques to handle the form's input values. The reactive forms state is immutable, any form filed change creates a new state for the form. Reactive forms are built around observable streams, where form inputs and values are provided as streams of input values, which can be accessed synchronously. Some key notations that involve in reactive forms are like: FormControl - each input element in the form is 'FormControl'. The 'FormControl' tracks the value and validation status of form fields. FormGroup - Track the value and validate the state of the group of 'FormControl'. FormBuilder - Angular service which can be used to create the 'FormGroup' or FormControl instance quickly. Form Array - That can hold infinite form control, this helps to create dynamic forms. Create An Angular(14) Application: Let'

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

.NET 7 Web API CRUD Using Entity Framework Core

In this article, we are going to implement a sample .NET 7 Web API CRUD using the Entity Framework Core. Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, and desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains programming functions that can be requested via HTTP calls either to fetch or update data for their respective clients. Some of the Key Characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build the REST full services. Install The SQL Server And SQL Management Studio: Let's install the SQL server on our l

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. 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 the .NET CLI command) editor. Create a fo

Angular 14 State Management CRUD Example With NgRx(14)

In this article, we are going to implement the Angular(14) state management CRUD example with NgRx(14) NgRx Store For State Management: In an angular application to share consistent data between multiple components, we use NgRx state management. Using NgRx state helps to avoid unwanted API calls, easy to maintain consistent data, etc. The main building blocks for the NgRx store are: Actions - NgRx actions represents event to trigger the reducers to save the data into the stores. Reducer - Reducer's pure function, which is used to create a new state on data change. Store - The store is the model or entity that holds the data. Selector - Selector to fetch the slices of data from the store to angular components. Effects - Effects deals with external network calls like API. The effect gets executed based the action performed Ngrx State Management flow: The angular component needs data for binding.  So angular component calls an action that is responsible for invoking the API call.  Aft

ReactJS(v18) JWT Authentication Using HTTP Only Cookie

In this article, we will implement the ReactJS application authentication using the HTTP-only cookie. HTTP Only Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing the JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-ONly cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use the authentication with HTTP-only JWT cookie then we no need to implement the custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To authenticate our client application with JWT HTTP-only cookie, I developed a NetJS(which is a node) Mock API. Check the GitHub link and read the document on G

Angular 14 Crud Example

In this article, we will implement CRUD operation in the Angular 14 application. Angular: Angular is a framework that can be used to build a single-page application. Angular applications are built with components that make our code simple and clean. Angular components compose of 3 files like TypeScript File(*.ts), Html File(*.html), CSS File(*.cs) Components typescript file and HTML file support 2-way binding which means data flow is bi-directional Component typescript file listens for all HTML events from the HTML file. Create Angular(14) Application: Let's create an Angular(14) application to begin our sample. Make sure to install the Angular CLI tool into our local machine because it provides easy CLI commands to play with the angular application. Command To Install Angular CLI npm install -g @angular/cli Run the below command to create the angular application. Command To Create Angular Application ng new name_of_your_app Note: While creating the app, you will see a noti

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in