Build REST CRUD APIs with .Net and Microsoft SQL Server
These are APIs that .Net backend App will export:
Create database and table.
CREATE DATABASE testdb;
CREATE TABLE users (id INT NOT NULL IDENTITY PRIMARY KEY,first_name VARCHAR(100) NOT NULL,last_name VARCHAR(100),email VARCHAR(100) NOT NULL,);
Project directory:
User Entity
Path: /Entities/User.cs
The user entity class represents the data stored in the database for users.
namespace WebApi.Entities;
using System.Text.Json.Serialization;
public class User{ public int Id { get; set; } public string FirstName { get; set; } public string LastName { get; set; } public string Email { get; set; } }
App Exception
Path: /Helpers/AppException.cs
The app exception is a custom exception class used to differentiate between handled and unhandled exceptions in the .NET API. Handled exceptions are generated by application code and used to return custome error messages.
namespace WebApi.Helpers;
using System.Globalization;
public class AppException : Exception{ public AppException() : base() {}
public AppException(string message) : base(message) { }
public AppException(string message, params object[] args) : base(String.Format(CultureInfo.CurrentCulture, message, args)) { }}
AutoMapper Profile
Path: /Helpers/AutoMapperProfile.cs
AutoMapper is an object mapper that helps you transform one object of one type into an output object of a different type. This type of transformation is often needed when you work on business logic. In this example we're using it to map between User entities and a couple of different model types - CreateRequest and UpdateRequest.
namespace WebApi.Helpers;
using AutoMapper;using WebApi.Entities;using WebApi.Models.Users;
public class AutoMapperProfile : Profile{ public AutoMapperProfile() { // CreateRequest -> User CreateMap<CreateRequest, User>();
// UpdateRequest -> User CreateMap<UpdateRequest, User>() .ForAllMembers(x => x.Condition( (src, dest, prop) => { // ignore both null & empty string properties if (prop == null) return false; if (prop.GetType() == typeof(string) && string.IsNullOrEmpty((string)prop)) return false;
return true; } )); }}
Data Context
Path: /Helpers/DataContext.cs
The primary class that is responsible for interacting with data as objects is the DbContext. The recommended way to work with context is to define a class that derives from the DbContext and exposes the DbSet properties that represent collections of the specified entities in the context.
options.UseSqlServer(Configuration.GetConnectionString("ApiDatabase") configures Entity Framework to create and connect to a SQL Server.
UseSnakeCaseNamingConvention(): This will automatically make all your table and column names have snake_case naming.
namespace WebApi.Helpers;
using Microsoft.EntityFrameworkCore;using WebApi.Entities;
public class DataContext : DbContext{ protected readonly IConfiguration Configuration;
public DataContext(IConfiguration configuration) { Configuration = configuration; }
protected override void OnConfiguring(DbContextOptionsBuilder options) { // connect to sql server with connection string from app settings options.UseSqlServer(Configuration.GetConnectionString("ApiDatabase")). UseSnakeCaseNamingConvention(); }
public DbSet<User> Users { get; set; }}
Global Error Handler Middleware
Path: /Helpers/ErrorHandlerMiddleware.cs
Using the global error handler, we can extract all the exception handling logic into a single centralized place. It's configured as middleware in the Program.cs file.
namespace WebApi.Helpers;
using Microsoft.AspNetCore.Http;using Microsoft.Extensions.Logging;using System;using System.Collections.Generic;using System.Net;using System.Text.Json;using System.Threading.Tasks;
public class ErrorHandlerMiddleware{ private readonly RequestDelegate _next; private readonly ILogger _logger;
public ErrorHandlerMiddleware(RequestDelegate next, ILogger<ErrorHandlerMiddleware> logger) { _next = next; _logger = logger; }
public async Task Invoke(HttpContext context) { try { await _next(context); } catch (Exception error) { var response = context.Response; response.ContentType = "application/json";
switch (error) { case AppException e: // custom application error response.StatusCode = (int)HttpStatusCode.BadRequest; break; case KeyNotFoundException e: // not found error response.StatusCode = (int)HttpStatusCode.NotFound; break; default: // unhandled error _logger.LogError(error, error.Message); response.StatusCode = (int)HttpStatusCode.InternalServerError; break; }
var result = JsonSerializer.Serialize(new { message = error?.Message }); await response.WriteAsync(result); } }}
Interface User Service
Path: /Services/IUserService.cs
The user service is responsible for all database interaction and core business logic related to user CRUD operations.
namespace WebApi.Services;
using WebApi.Entities;using WebApi.Models.Users;
public interface IUserService{ IEnumerable<User> GetAll(); User GetById(int id); void Create(CreateRequest model); void Update(int id, UpdateRequest model); void Delete(int id);}
User Service Implementation
The UserService.cs is a concrete user service class that implements the interface.
using AutoMapper;using WebApi.Entities;using WebApi.Helpers;using WebApi.Models.Users;
namespace WebApi.Services{ public class UserService : IUserService { private DataContext _context; private readonly IMapper _mapper;
public UserService( DataContext context, IMapper mapper) { _context = context; _mapper = mapper; }
public IEnumerable<User> GetAll() { return _context.Users; }
public User GetById(int id) { return getUser(id); }
public void Create(CreateRequest model) { // validate if (_context.Users.Any(x => x.Email == model.Email)) throw new AppException("User with the email '" + model.Email + "' already exists");
// map model to new user object var user = _mapper.Map<User>(model);
// save user _context.Users.Add(user); _context.SaveChanges(); }
public void Update(int id, UpdateRequest model) { var user = getUser(id);
// validate if (model.Email != user.Email && _context.Users.Any(x => x.Email == model.Email)) throw new AppException("User with the email '" + model.Email + "' already exists");
// copy model to user and save _mapper.Map(model, user); _context.Users.Update(user); _context.SaveChanges(); }
public void Delete(int id) { var user = getUser(id); _context.Users.Remove(user); _context.SaveChanges(); }
// helper methods
private User getUser(int id) { var user = _context.Users.Find(id); if (user == null) throw new KeyNotFoundException("User not found"); return user; } }}
CreateRequest.cs
Path: /Models/Users/CreateRequest.cs
namespace WebApi.Models.Users;
using System.ComponentModel.DataAnnotations;using WebApi.Entities;
public class CreateRequest{
[Required] public string FirstName { get; set; }
[Required] public string LastName { get; set; }
[Required] [EmailAddress] public string Email { get; set; }
}
UpdateRequest.cs
Path: /Models/Users/UpdateRequest.cs
namespace WebApi.Models.Users;
using System.ComponentModel.DataAnnotations;using WebApi.Entities;
public class UpdateRequest{ public string FirstName { get; set; } public string LastName { get; set; }
[EmailAddress] public string Email { get; set; }
private string replaceEmptyWithNull(string value) { return string.IsNullOrEmpty(value) ? null : value; }}
Users Controller
Path: /Controllers/UsersController.cs
The controller defines and handles all routes / endpoints for the api that relate to users, this includes standard CRUD operations for retrieving, updating, creating and deleting users.
namespace WebApi.Controllers;
using AutoMapper;using Microsoft.AspNetCore.Mvc;using WebApi.Models.Users;using WebApi.Services;
[ApiController][Route("api/v1/[controller]")]public class UsersController : ControllerBase{ private IUserService _userService; private IMapper _mapper;
public UsersController( IUserService userService, IMapper mapper) { _userService = userService; _mapper = mapper; }
[HttpGet] public IActionResult GetAll() { var users = _userService.GetAll(); return Ok(users); }
[HttpGet("{id}")] public IActionResult GetById(int id) { var user = _userService.GetById(id); return Ok(user); }
[HttpPost] public IActionResult Create(CreateRequest model) { _userService.Create(model); return Ok(new { message = "User created" }); }
[HttpPut("{id}")] public IActionResult Update(int id, UpdateRequest model) { _userService.Update(id, model); return Ok(new { message = "User updated" }); }
[HttpDelete("{id}")] public IActionResult Delete(int id) { _userService.Delete(id); return Ok(new { message = "User deleted" }); }}
.NET 6 Program
Path: /Program.cs
Program.cs is the entry point of our app, where we configure the Web host. The program class configures the application infrastructure like Web host, logging, Dependency injection container, IIS integration, etc.
using System.Text.Json.Serialization;using WebApi.Helpers;using WebApi.Services;
var builder = WebApplication.CreateBuilder(args);
// add services to DI container{ var services = builder.Services; var env = builder.Environment; services.AddDbContext<DataContext>(); services.AddCors(); services.AddControllers().AddJsonOptions(x => { // serialize enums as strings in api responses (e.g. Role) x.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
// ignore omitted parameters on models to enable optional params (e.g. User update) x.JsonSerializerOptions.DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull; }); services.AddAutoMapper(AppDomain.CurrentDomain.GetAssemblies());
// configure DI for application services services.AddScoped<IUserService, UserService>();}
var app = builder.Build();
// configure HTTP request pipeline{ // global cors policy app.UseCors(x => x .AllowAnyOrigin() .AllowAnyMethod() .AllowAnyHeader());
// global error handler app.UseMiddleware<ErrorHandlerMiddleware>();
app.MapControllers();}
app.Run("http://localhost:9080");
.NET App Settings JSON
Path: /appsettings.json
The appsettings.json file is an application configuration file used to store configuration settings such as database connections strings, any application scope global variables, etc.
{ "Logging": { "LogLevel": { "Default": "Information", "Microsoft.AspNetCore": "Warning" } }, "ConnectionStrings": { "ApiDatabase": "Data Source=localhost:1433; Initial Catalog=testdb; User Id=knfuser; Password=root;Encrypt=False;" }}
WebApi.csproj
Path: /WebApi.csproj
The csproj (C# project) is an MSBuild based file that contains target framework and NuGet package dependency information for the application.
The EFCore.NamingConventions plugin to automatically set all your table and column names to snake_case instead.
The Microsoft.EntityFrameworkCore.SqlServer database provider allows Entity Framework Core to be used with Microsoft SQL Server (including SQL Azure). The provider is maintained as part of the Entity Framework Core Project.
<Project Sdk="Microsoft.NET.Sdk.Web"> <PropertyGroup> <TargetFramework>net6.0</TargetFramework> <ImplicitUsings>enable</ImplicitUsings> </PropertyGroup> <ItemGroup> <PackageReference Include="AutoMapper" Version="11.0.1" /> <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="11.0.0" /> <PackageReference Include="EFCore.NamingConventions" Version="7.0.2" /> <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="7.0.2" /> </ItemGroup></Project>
Run the application and verify REST APIs
Download the source code - click here!
You can start the api by running dotnet run from the command line in the project root folder (where the WebApi.csproj file is located), you should see the message Now listening on: http://localhost:9080.
OR
You can also start the application in debug mode in Visual Studio by opening the project root folder in Visual Studio and pressing F5 or by selecting Debug -> Start Debugging from the top menu, running in debug mode.
Add User:
Update User by ID:
Fetch all Users:
Get User by ID:
Delete User by ID:
