CRUD Operation With .NET Core 3.1 And Entity Framework Core

In this article I am going to walk you through CRUD operation using .net core 3.1 and entity framework core and SQL Server to store data. Here I will explain step by step how to Create, Read, Update and Delete employees from sql table using Rest API, EntityFramework core and sql server.

 

Before starting this there are a few prerequisites as below,

1. Visual Studio 2019
2. SQL server 2017
3. .Net core 3.1
4. Entity Framework core
5. PostMan to test rest api. 

Let's start with Visual Studio to create Rest API endpoint for Create, Read, Update and Delete method using core api 3.1.

1. Start Visual Studio 2019 and click create a new project from the below screen. 

• Once you  click on a new project you will get a new screen to select Asp .Net Core Web Application from the below screen and click on next button. 

 

• After clicking on the next button give a project name and location for your project where you want to save your project. 

 

• Now we have the option to select framework and framework version as in the below screen, I have selected core and version core 3.1.

 

• After selecting the above option click on create. You are done with you new project for Rest API Core 3.1.

 

• Once you are done with new core api project, you will get default controller with Weatherforcast as below. 

 

• Once you build your application then you should get the below screen by default. If you are getting the below screen then your solution is up and running.

• Now let's start with SQL server script to create table in database.
  

  CREATE TABLE [dbo].[Employees](
      [Id] [int] IDENTITY(1,1) NOT NULL,
      [FirstName] [varchar](50) NOT NULL,
      [LastName] [varchar](50) NOT NULL,
      [Email] [varchar](50) NOT NULL,
      [City] [varchar](50) NOT NULL,
      [Salary] [int] NOT NULL,
  PRIMARY KEY CLUSTERED
  (
      [Id] ASC
  )WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
  ) ON [PRIMARY]

• Now let's create new folder as Model and add new class with name Employee under Model folder,
  

  using System.ComponentModel.DataAnnotations;
  
  namespace RestAPICoreDemo.Model
  {
  
      public class Employee
      {
          [Key]
          public int Id { get; set; }
          public string FirstName { get; set; }
          public string LastName { get; set; }
          public string Email { get; set; }
          public string City { get; set; }
          public int Salary { get; set; }
  
      }
  }

• Now add EntityFrameworkCore package from nuget package manger. Install packages for Entity framework core
• Microsoft.EntityFrameworkCore.SqlServer

 

• Let's creat EmployeeContext which is used to communicate with database and help us to do operations like Create, Read, Update and Delete operation for our table.
  

  using Microsoft.EntityFrameworkCore;
  using RestAPICoreDemo.Model;
  
  namespace RestAPICoreDemo
  {
      public class EmployeeContext : DbContext
      {
          public EmployeeContext(DbContextOptions<EmployeeContext> options) : base(options)
          {
  
          }
  
          public DbSet<Employee> Employees { get; set; }
      }
  }

• Let's create Employee service to perform all operation like Create, Read, Update and Delete operations. Add Service contract using interface and implement same interface using employee service.

• Add service contract in Employee service interface

IEmployeeService.cs

using RestAPICoreDemo.Model;
using System.Collections.Generic;

namespace RestAPICoreDemo.Service
{
    public interface IEmployeeService
    {

        Employee AddEmployee(Employee employee);

        List<Employee> GetEmployees();

        void UpdateEmployee(Employee employee);

        void DeleteEmployee(int Id);

        Employee GetEmployee(int Id);
    }
}

EmployeeService.cs

using RestAPICoreDemo.Model;
using System.Collections.Generic;
using System.Linq;

namespace RestAPICoreDemo.Service
{
    public class EmployeeService : IEmployeeService
    {
        public EmployeeContext _employeeDbContext;
        public EmployeeService(EmployeeContext employeeDbContext)
        {
            _employeeDbContext = employeeDbContext;
        }
        public Employee AddEmployee(Employee employee)
        {
            _employeeDbContext.Employees.Add(employee);
            _employeeDbContext.SaveChanges();
            return employee;
        }
        public List<Employee> GetEmployees()
        {
            return _employeeDbContext.Employees.ToList();
        }

        public void UpdateEmployee(Employee employee)
        {
            _employeeDbContext.Employees.Update(employee);
            _employeeDbContext.SaveChanges();
        }

        public void DeleteEmployee(int Id)
        {
            var employee = _employeeDbContext.Employees.FirstOrDefault(x => x.Id == Id);
            if (employee != null)
            {
                _employeeDbContext.Remove(employee);
                _employeeDbContext.SaveChanges();
            }
        }

        public Employee GetEmployee(int Id)
        {
            return _employeeDbContext.Employees.FirstOrDefault(x => x.Id == Id);
        }

    }
}

• EmployeeController
  

using System.Collections.Generic;
using Microsoft.AspNetCore.Mvc;
using RestAPICoreDemo.Model;
using RestAPICoreDemo.Service;

namespace RestAPICoreDemo.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class EmployeeController : ControllerBase
    {
        private readonly IEmployeeService _employeeService;
        public EmployeeController(IEmployeeService employeeService)
        {
            _employeeService = employeeService;
        }

        [HttpGet]
        [Route("[action]")]
        [Route("api/Employee/GetEmployees")]
        public IEnumerable<Employee> GetEmployees()
        {
            return _employeeService.GetEmployees();
        }

        [HttpPost]
        [Route("[action]")]
        [Route("api/Employee/AddEmployee")]
        public IActionResult AddEmployee(Employee employee)
        {
            _employeeService.AddEmployee(employee);
            return Ok();
        }

        [HttpPost]
        [Route("[action]")]
        [Route("api/Employee/UpdateEmployee")]
        public IActionResult UpdateEmployee(Employee employee)
        {
            _employeeService.UpdateEmployee(employee);
            return Ok();
        }

        [HttpDelete]
        [Route("[action]")]
        [Route("api/Employee/DeleteEmployee")]
        public IActionResult DeleteEmployee(int id)
        {
            var existingEmployee = _employeeService.GetEmployee(id);
            if (existingEmployee != null)
            {
                _employeeService.DeleteEmployee(existingEmployee.Id);
                return Ok();
            }
            return NotFound($"Employee Not Found with ID : {existingEmployee.Id}");
        }

        [HttpGet]
        [Route("GetEmployee")]
        public Employee GetEmployee(int id)
        {
            return _employeeService.GetEmployee(id);
        }

    }
}

• We are done with service contract and implementation for all methods. 
• Now need for dependency for employee service and Connection string in start up class file.
  

  public void ConfigureServices(IServiceCollection services)
  {
      services.AddControllers();
      services.AddDbContextPool<EmployeeContext>(options =>
      options.UseSqlServer(Configuration.GetConnectionString("EmployeeDBContextConnectionString")));
       services.AddScoped<IEmployeeService, EmployeeService>();
  }

• Now we are ready with all required changes, let's build and run our Web API solution.
• Use Postman to test our API CRUD operation.
• Let's check our SQL Table with select statement. Initially there will not be any records in Employee table.

 

• Now open Postman and create new employee using "api/Employee/AddEmployee" end point.

 

 

• Read Employee using "api/Employee/GetEmployees" end point.

• Update Employee "api/Employee/UpdateEmployee" using end point.

• Let's check updated employee using "api/Employee/GetEmployee" endpoint which should return employee details with updated data as below.

 

• Delete Employee "api/Employee/DeleteEmployee" using end point which should retunr status code 200 with Ok. It means deleted employee from table.

• Let's check the same employee using "api/Employee/GetEmployee" by passing employee id. Now it should return status code 204 No Content. It means employee is sucessfully deleted using delete endpoint.

 

• Let's finally check in SQL table there will be no records as we deleted employee using delete endpoint.

 

• At last I am submitting a few records using "api/Employee/AddEmployee" endpoint and then will fetch all employees using "api/Employee/GetEmployees" 

 

 

• Finally I am going to verify these records in sql server table using select query and it shoud return all records. 

 

 

Summary

 

In this article we have learned how to build CRUD operation using .net core 3.1, entityframework core, sql server and used postman for testing all end points. I hope you have enjoyed this article. Thank you for your time and always feel free to reeach out to me in case you have any queries. Please find my other article at this link My Articles