Skip to main content

A Sample On .Net Core Web API Using Dapper


Overview On Dapper Object-Relational Mapping:

Dapper is an Object-Relational Mapping framework for .Net applications. It is a mapping model between the database and .Net objects. The Dapper provides all query and command execution methods as extension methods under the 'System.Data.IDbConnection' interface. The Dapper works as a similar ADO.Net but with much more model mapping support. The Dapper key features are like:
  • High performance in query execution
  • Multiple query execution support
  • An easy model mapping between the .Net Object and database result.

Create A Sample .Net Core Web API Application:

Let's understand the Dapper ORM query and commands execution steps by writing some sample code, so let's get started by creating a .Net Core Web API application. The IDE's for development can be chosen by personal preference but the most recommended IDE's are Visual Studio 2019 and Visual Studio Code.

SQL Table Schema:

In this article we are going to work on 'Todo' table, so execute the below table schema.
CREATE TABLE [dbo].[Todo] (
    [Id]  INT  IDENTITY (1, 1) NOT NULL,
    [ItemName] VARCHAR (MAX) NULL,
    [IsCompleted] BIT NOT NULL
);
Now run the sample test data.
SET IDENTITY_INSERT [dbo].[Todo] ON
INSERT INTO [dbo].[Todo] ([Id], [ItemName], [IsCompleted]) VALUES (1, N'Buy a book', 1)
INSERT INTO [dbo].[Todo] ([Id], [ItemName], [IsCompleted]) VALUES (2, N'Need To Watch Movie', 0)
INSERT INTO [dbo].[Todo] ([Id], [ItemName], [IsCompleted]) VALUES (3, N'Book A Flight Ticke', 0)
SET IDENTITY_INSERT [dbo].[Todo] OFF

Install Packages:

SQL Provider Package:

Install-Package System.Data.SqlClient
Dapper Package:

Install-Package Dapper

Initial Project Configuration Steps(Connection String / Models / Repositories):

In this section we are going to implement initial steps like adding ConnectionString, Models, Repositories with some basic configurations.

In appsettings.development.json file add your SQL connection string as below.
{
  "Logging": {
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "MyWorldDbConnection": "your_sql_server_connection"
  }
}
Now add Todo.cs model
Models/Todo.cs:
namespace API.Dapper.Sample.Models
{
    public class Todo
    {
        public int Id { get; set; }
        public string ItemName { get; set; }
        public bool IsCompleted { get; set; }
    }
}
Now let's create 'Todo' repository and it interface.
Repos/ITodoRepository.cs:
using API.Dapper.Sample.Models;
using System.Collections.Generic;
using System.Threading.Tasks;

namespace API.Dapper.Sample.Repos
{
    public interface ITodosRepository
    {
        
    }
}
  • Here we have added few references(libraries accessed with using statement) intentionally because all these references are required by us on completion of the sample.
Repos/TodoRepository.cs:
using API.Dapper.Sample.Models;
using Dapper;
using Microsoft.Extensions.Configuration;
using System.Collections.Generic;
using System.Data;
using System.Data.SqlClient;
using System.Linq;
using System.Threading.Tasks;

namespace API.Dapper.Sample.Repos
{
    public class TodosRepository: ITodosRepository
    {
        private string myWorldDbConnection = string.Empty;

        private IDbConnection Connection
        {
            get
            {
                return new SqlConnection(myWorldDbConnection);
            }
        }
        public TodosRepository(IConfiguration configuration)
        {
            myWorldDbConnection = configuration.GetConnectionString("MyWorldDbConnection");
        }
    }
}
  • (Line: 25) The 'Microsoft.Extensions.Configuration.IConfiguration' is injected into the 'TodosRepository'. The 'IConfiguration' interface has the capability to access the appsettings. The 'GetConnectionString()' is default method in 'IConfiguration' which can read the 'ConnectionStrings' property object in the appsettings.
  • (Line: 16-22) The 'Connection' property of type 'System.Data.IDbConnection' initialized. This property uses 'System.Data.SqlClient.SqlConnection' instance to open the database connection.
Now register the 'TodosRepository' in DI(dependency injection) service in the startup file
Startup.cs:
public void ConfigureServices(IServiceCollection services)
{
	services.AddControllers();
	services.AddScoped<ITodosRepository, TodosRepository>();
}
Let's now add a 'TodosController' as follow
Controllers/TodosController.cs:
using API.Dapper.Sample.Models;
using API.Dapper.Sample.Repos;
using Microsoft.AspNetCore.Mvc;
using System.Threading.Tasks;

namespace API.Dapper.Sample.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class TodosController : ControllerBase
    {
        private readonly ITodosRepository _todosRepository;
        public TodosController(ITodosRepository todosRepository)
        {
            _todosRepository = todosRepository;
        }
    }
}
  • (Line: 13) Injects 'ITodosRepository'

Read Collection Of Records:

Using Dapper ORM query extension methods we need to fetch collection records from the database.

Now create an abstract method in the 'ITodosRepository.cs' that represents a method that outputs the collection of records.
Repos/ITodosRepository.cs:
Task<List<Todo>> GetAllTodosAsync();
Now implement this abstract method in the 'TodosRepository.cs'
Repos/TodosRepository.cs:
public async Task<List<Todo>> GetAllTodosAsync()
{
	using(IDbConnection conn = Connection)
	{
		string query = "SELECT * FROM Todo";
		List<Todo> todos = (await conn.QueryAsync<Todo>(sql: query)).ToList();
		return todos;
	}
}
  • (Line: 3) The 'using' statement automatically closes the database connection string once the scope of the code executes out the 'using' statement.
  • (Line: 5) The simple raw SQL query to fetch all records.
  • (Line: 6) The 'Dapper.SqlMapper..QueryAsync<T>()' method which we using as extension method of 'System.Data.IDbConnection'. The QueryAsync method executes the query which takes it as an input parameter and returns the data by mapping to the 'T' type defined to it.
Now define the action method endpoint.
Controllers/TodosController.cs:
[HttpGet]
[Route("get-all")]
public async Task<IActionResult> GetAllTodosAsync()
{
	var result = await _todosRepository.GetAllTodosAsync();
	return Ok(result);
}

Read Single Record:

Let's define an abstract method in 'ITodosRepository', this method going to fulfill the role to return a single record from our repository.
Repos/ITodosRepository.cs:
Task<Todo> GetTodoByIdAsync(int id);
Now let's implement this abstract method into our 'TodosRepository'
Repos/TodosRepository.cs:
public async Task<Todo> GetTodoByIdAsync(int id)
{
	using(IDbConnection conn = Connection)
	{
		string query = "SELECT * FROM Todo WHERE Id = @id";
		Todo todo = await conn.QueryFirstOrDefaultAsync<Todo>(sql: query, param: new { id });
		return todo;
	}
}
  • (Line: 5) Now the raw SQL query contains parameter '@id', dapper will pass the value at the time query execution.
  • (Line: 6) The extension method 'QueryFirstOrDefaultAsync' returns the first record as per the filter we passed. To this extension method, we are passing filter values as anonymous objects using the 'new' keyword.
Now define the action method endpoint
Controllers/TodosController.cs:
[HttpGet]
[Route("get-todoitem-by-id")]
public async Task<IActionResult> GetTodoItemByIdAsync(int id)
{
	var result = await _todosRepository.GetTodoByIdAsync(id);
	return Ok(result);
}

Read Multiple Result Sets:

The Dapper has the capability to return the multiple table results sets. Now let's create a new model to capture multiple results.
Models/TodosContainer.cs:
using System.Collections.Generic;

namespace API.Dapper.Sample.Models
{
    public class TodosContainer
    {
        public int Count { get; set; }
        public List<Todo> Todos {get;set;}
    }
}
  • Here we have 2 properties one for the total count and the other for the list of 'Todos'.
Now let's define an abstract method for reading multiple results in 'ITodosRepository'
Repos/ITodosRepository.cs:
Task<TodosContainer> GetTodosAndCountAsync();
Now let's write an implementation for this abstract method
Repos/TodosRepository.cs:
public async Task<TodosContainer> GetTodosAndCountAsync()
{
	using (IDbConnection conn = Connection)
	{
		string query = @"
				SELECT COUNT(*) FROM Todo

	
				SELECT * FROM Todo";

		var reader = await conn.QueryMultipleAsync(sql: query);

		return new TodosContainer
		{
			Count = (await reader.ReadAsync<int>()).FirstOrDefault(),
			Todos = (await reader.ReadAsync<Todo>()).ToList()
		};
	}
}
  • (Line: 5-9) Here defined to queries one returns count of todos and other returns total todos(If you want you can return select query of fetching data of two tables also).
  • (Line: 11) The extension method 'QueryMultipleAsync' executes the query and returns multiple result sets.
  • (Line: 15) Reading the first result set i.e total count.
  • (Line: 16) Reading the second result set i.e collection of 'Todos'.
Now let's define the action method endpoint.
Controllers/TodosController.cs:
[HttpGet]
[Route("get-todos-and-count")]
public async Task<IActionResult> GetTodosAndCountAsync()
{
	var result = await _todosRepository.GetTodosAndCountAsync();
	return Ok(result);
}

Save Record:

Repos/ITodosRepository.cs:
Task<int> SaveAsync(Todo newTodo);
Repos/TodosRepository.cs:
public async Task<int> SaveAsync(Todo newTodo)
{
	using(IDbConnection conn = Connection)
	{
		string command = @"
				INSERT INTO Todo(ItemName, IsCompleted)
				VALUES(@ItemName, @IsCompleted)";

		var result = await conn.ExecuteAsync(sql: command, param: newTodo);
		return result;
	}
}
  • (Line: 6-7) Here we can see SQL insert command and with dynamic parameters like '@ItemName','@IsCompleted'.
  • (Line: 9) The extension method 'ExecuteAsync' executes the given command to it. This method takes 'param' as 'newTodo'(Todo instance), each property name of 'newTodo' must match with the dynamic parameter name is the SQL command. The return type of the 'ExecuteAsync' is an integer value to represent the number of rows was effected on command execution, so if it returns zero then there is no effect of the command on the database.
Now let's define the action method endpoint.
Controllers/TodosController.cs:
[HttpPost]
[Route("save")]
public async Task<IActionResult> SaveAsync(Todo newTodo)
{
	var result = await _todosRepository.SaveAsync(newTodo);
	return Ok(result);
}

Update Record:

Repos/ITodosRepository:
Task<int> UpdateTodoStatusAsync(Todo updateTodo);
Repos/TodosRepository:
public async Task<int> UpdateTodoStatusAsync(Todo updateTodo)
{
	using(IDbConnection conn = Connection)
	{
		string command = @"
		UPDATE Todo SET IsCompleted = @IsCompleted WHERE Id = @Id";

		var result = await conn.ExecuteAsync(sql: command, param: updateTodo);
		return result;
	}
}
  • Here we are updating only the 'IsCompleted' column of the Todo table
Controllers/TodosController.cs:
[HttpPost]
[Route("update-todo-status")]
public async Task<IActionResult> UpdateTodoStatusAsync(Todo updateTodo)
{
	var result = await _todosRepository.UpdateTodoStatusAsync(updateTodo);
	return Ok(result);
}

Delete Record:

Repos/ITodosRepository:
Task<int> DeleteAsync(int id);
Repos/TodosRepository:
public async Task<int> DeleteAsync(int id)
{
	using(IDbConnection conn = Connection)
	{
		string command = @"DELETE FROM Todo WHERE Id = @id";
		var result = await conn.ExecuteAsync(sql: command, param: new { id });
		return result;
	}
}
  • Here we can observe SQL raw delete query based on the '@id' parameter
Controllers/TodoController.cs:
[HttpDelete]
[Route("delete")]
public async Task<IActionResult> DeleteAsync(int id)
{
	var result = await _todosRepository.DeleteAsync(id);
	return Ok(result);
}

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on the Dapper ORM integration in .Net Core Application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

Post a Comment

Popular posts from this blog

.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

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

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

.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

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

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

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