Skip to main content

.NET6 Web API CRUD Operation With MongoDB

In this article, we are going to implement .NET6 Web API CRUD operation using MongoDB as database.

MongoDB:

MongoDB is a source-available cross-platform document-oriented database. It is also called a NoSQL database or Non-Relational database.

In MongoDB 'Collection' is equivalent to the Table in SQL database.

In MongoDB data is stored as 'Document' that is equivalent to a table record in an SQL database. The 'Document' contains JSON data which will be stored in BSON(Binary JSON) format.

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

MongoDB Docker Image:

In this demo, I will consume the MongoDB that's run as a Docker container.

Install MongoDB NuGet:

Package Manager:
Install-Package MongoDB.Driver -Version 2.14.1

.NET CLI Command
dotnet add package MongoDB.Driver --version 2.14.1

Add MongoDB Configurations:

Let's configure MongoDB settings like 'connectionstring', 'databasename', etc into our API project. In the 'appSettings.Development.json' file add MongoDB settings.
appSettings.Development.json:
"MongoDBSettings":{
  "ConnectionString":"mongodb://localhost:8007",
  "DatabaseName":"myworld"
}
  • Here connection string to dockerized MongoDB is 'mongodb://localhost:8007'
  • Here my database name is 'myworld'.
Let's create an entity for the above MongoDB settings like 'MogoDBSettngs.cs' inside of the 'Models' folder.
Models/MongoDBSettings.cs:
namespace Dot6.MongoDb.API.CRUD.Models;

public class MongoDBSettings
{
    public string ConnectionString { get; set; }
    public string DatabaseName { get; set; }
}
Now register the 'MongoDBSettings' instance by mapping the MongoDB json settings to it in the 'Program.cs'
Program.cs:
builder.Services.Configure<MongoDBSettings>(
    builder.Configuration.GetSection("MongoDBSettings")
);

Register IMongoDatabase:

Now let's register the 'MongoDB.Driver.IMongoDatabase' in the 'Program.cs', so that we can inject the 'MongoDB.Driver.IMongoDatabase' into our application where ever we need it.
Program.cs:
builder.Services.AddSingleton<IMongoDatabase>(options => {
    var settings =  builder.Configuration.GetSection("MongoDBSettings").Get<MongoDBSettings>();
    var client = new MongoClient(settings.ConnectionString);
    return client.GetDatabase(settings.DatabaseName);
});
  • (Line: 1) The 'MongoDB.Driver.IMongoDatabase' is registered as singleton instance.
  • (Line: 2) Fetching the 'MongoDBSettings'.
  • (Line: 3) Initialized the 'MongoDB.Driver.MongoClient' by passing the connection string as an input value.
  • (Line: 4) Creating the instance for 'IMongoDatabase' using the 'MongClient.GetDatabase()' method that takes the database name as the input parameter.

Create Entity For MongoDB Collection:

Now let's create an entity or class for the MongoDB collection. For this demo, I have created a collection(equivalent to the table of SQL) like 'people' in MongoDB. So let's create an entity for the 'people' collection like 'People.cs' in the 'Collection' folder.
Collection/People.cs:
using MongoDB.Bson;
using MongoDB.Bson.Serialization.Attributes;

namespace Dot6.MongoDb.API.CRUD.Collections;

public class People
{
    [BsonId]
    [BsonRepresentation(BsonType.ObjectId)]
    public string Id { get; set; }

    [BsonElement("name")]
    public string Name { get; set; }

    [BsonElement("age")]
    public int Age{get;set;}

    [BsonElement("phonenumbers")]
    public List<string> PhoneNumbers{get;set;}
}
  • (Line: 8) The 'BsonId' attribute decorated on the property makes as the primary key for the document in the MongoDB.
  • (Line: 9) The 'BsonRepresentation(BsonType.ObjectId)' attribute decorated on the property allow the parameter as type of string instead of the 'ObjectId'(in the MongoDB document). It Handles the conversion from string to ObjectId for MongoDB.
  • The 'BsonElement' attribute is to map the MongoDB property to entity property for reading the data.

Create A Repository For A MongoDB Collection:

Here we are going to use a repository pattern for communicating with MongoDB. For this demo, I have created a collection(equivalent to the table of SQL) like 'people' in MongoDB. So let's create a repository file for the 'people' collection like 'PeopleRepository.cs' which contains all the logic communicating with MongoDB.
Repository/IPeopleRepository.cs:
using Dot6.MongoDb.API.CRUD.Collections;
namespace Dot6.MongoDb.API.CRUD.Repository;

public interface IPeopleRepository
{
    
}
Repository/PeopleRepository.cs:
using Dot6.MongoDb.API.CRUD.Collections;
using MongoDB.Driver;

namespace Dot6.MongoDb.API.CRUD.Repository;

public class PeopleRepository:IPeopleRepository
{
    private readonly IMongoCollection<People> _peopleCollection;

    public PeopleRepository(IMongoDatabase mongoDatabase)
    {
        _peopleCollection = mongoDatabase.GetCollection<People>("people");
    }
}
  • (Line: 8) Declare a variable '_peopleCollection' of type 'MongoDB.Driver.IMongoCollection<People>', this will give control over the 'people' collection in the MongoDB.
  • (Line: 9) Injected the 'MongoDB.Driver.IMongoDatabase'.
  • (Line: 12) Creating the instance for 'IMongoCollection' from the 'IMongoDatabase.GetCollection<People>()' method where we pass the collection name as the input parameter.
Now register our repository in the 'Program.cs' file.
Program.cs:
builder.Services.AddSingleton<IPeopleRepository, PeopleRepository>();

Create A API Controller:

Let's create an API controller like 'PeopleController.cs'
Controllers/PeopleController.cs:
using Dot6.MongoDb.API.CRUD.Collections;
using Dot6.MongoDb.API.CRUD.Repository;
using Microsoft.AspNetCore.Mvc;

namespace Dot6.MongoDb.API.CRUD.Controllers;

[ApiController]
[Route("[controller]")]
public class PeopleController : ControllerBase
{
    private readonly IPeopleRepository _ipeopleRepository;
    public PeopleController(IPeopleRepository ipeopleRepository)
    {
        _ipeopleRepository = ipeopleRepository;
    }
}
  • Here 'IPeopleRepository' injected into our controller.

Read Operation:

Let's implement an API action method that will fetch all the documents from MongoDB.

Let's add a method definition for fetching all documents into the 'IPeopleRepository.cs'.
Repository/IPeopleRepository.cs:
Task<List<People>> GetAllAsync();
Now let's implement the 'GetAllAsync()' method into the 'PeopleRepository.cs'
PeopleRepository.cs:
public async Task<List<People>> GetAllAsync()
{
	return await _peopleCollection.Find(_ => true).ToListAsync();
}
  • Here 'MongoDB.Driver.Find()' method filters the documents from the collections. If we pass 'true' as an input parameter it will fetch all the documents from the database.
Let's create our action method to fetch all the documents of MongoDB.
Controllers/PeopleController.cs:
[HttpGet]
public async Task<IActionResult> Get()
{
	var people = await _ipeopleRepository.GetAllAsync();
	return Ok(people);
}

Create Operation:

Let's implement the API action method to create a new document into the collection of MongoDB. Here along with the create action method, we will add one more additional action method that is get action method by 'Id' value that helps to fetch the newly created document.

Let's define method definitions for creating the document and get the document by 'id'.
Repository/IPeopleRepository.cs:
Task<People> GetByIdAsync(string id);
Task CreateNewPeopleAsync(People newPeople);
Now let's implement 'GetByIdAsync()', 'CreateNewPeopleAsync()' method in 'PeopleRepository.cs'.
Repository/PeopleRepository.cs:
public async Task<People> GetByIdAsync(string id)
{
	return await _peopleCollection.Find(_ => _.Id == id).FirstOrDefaultAsync();
}

public async Task CreateNewPeopleAsync(People newPeople)
{
	await _peopleCollection.InsertOneAsync(newPeople);
}
  • (Line: 3) The 'MongoDB.Driver.Find()' method fetches the document that matched with the 'id' value.
  • (Line: 8) The 'MongoDB.Driver.InsertOneAsync()' method insert the new document into the collection.
Let's add our create and get by id action methods into our controller.
Controller/PeopleController.cs:
[HttpGet]
[Route("{id}")]
public async Task<IActionResult> Get(string id)
{
	var people = await _ipeopleRepository.GetByIdAsync(id);
	if (people == null)
	{
		return NotFound();
	}

	return Ok(people);
}

[HttpPost]
public async Task<IActionResult> Post(People newPeople)
{
	await _ipeopleRepository.CreateNewPeopleAsync(newPeople);
	return CreatedAtAction(nameof(Get), new { id = newPeople.Id }, newPeople);
}
  • (Line: 3-12) Action method return the document by 'id' value.
  • (Line: 14-19) Insert the new document into the collection
  • (Line: 18) The 'CreatedAction' method returns the status code of 201(created), it also frames the endpoint for fetching documents by id and returns in the response header.

Update Operation:

Let's implement an action method to update the existing document in the collection.

Let's define the method definition for updating a document in 'IPeopleRepository.cs'
Repository/IPeopleRepository:
Task UpdatePeopleAsync(People peopleToUpdate);
Now let's implement 'UpdatePeopleAsync()' method in the 'PeopleRepository.cs'.
Repository/PeopleRepository:
public async Task UpdatePeopleAsync(People peopleToUpdate)
{
	await _peopleCollection.ReplaceOneAsync(x => x.Id == peopleToUpdate.Id, peopleToUpdate);
}
  • Here 'MongoDB.Driver.ReplacOneAsync()' method updates the document of the collection. The first input parameter finds the document, the second input parameter is the latest changes to the document that needs to be saved.
Add a new action method to our controller.
Controllers/PeopleController.cs:
[HttpPut]
public async Task<IActionResult> Put(People updatePeople)
{
	var people = await _ipeopleRepository.GetByIdAsync(updatePeople.Id);
	if (people == null)
	{
		return NotFound();
	}

	await _ipeopleRepository.UpdatePeopleAsync(updatePeople);
	return NoContent();
}
  • (Line: 4-8) Checking the document we are trying to update is valid or not. If not valid we return a response like 'NotFound'.
  • (Line: 10) Updating the document into the collection.

Delete Operation:

Let's implement the API action method that deletes the document from the collection of MongoDB.

Let's define the delete method definition in the 'IPeopleRepository'
Repository/IPeopleRepository:
Task DeletePeopleAsync(string id);
Let's implement the delete method in the 'PeopleRepository'.
Repository/PeopleRepository:
public async Task DeletePeopleAsync(string id)
{
	await _peopleCollection.DeleteOneAsync(x => x.Id == id);
}
  • Here 'MongoDB.Driver.DeleteOneAsync' method deletes the specified document from the collection.
Add a new action method into our controller.
Controllers/PeopleController.cs:
[HttpDelete]
public async Task<IActionResult> Delete(string id)
{
	var people = await _ipeopleRepository.GetByIdAsync(id);
	if (people == null)
	{
		return NotFound();
	}

	await _ipeopleRepository.DeletePeopleAsync(id);
	return NoContent();
}
  • (Line: 4-8) Checks the document that going to be deleted from the collection exists or not. If not exist then returns response as 'NotFound()'.
  • (Line: 10) Deletes the document from the collection.

Support Me!
Buy Me A Coffee PayPal Me

Video Session:

Wrapping Up:

Hopefully, I think this article delivered some useful information on .NET6 Web API CRUD operation with MongoDB. using I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

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

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

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

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

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

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

Different HttpClient Techniques To Consume API Calls In Minimal API[.NET6]

In this article, we are going to implement different HttpClient techniques to consume API calls in minimal API. The different HttpClient techniques that we are going to explore are like: Register HttpClient Object Explicitly In DI(Dependency Injection Service) Named Client Type Client HttpRequestMessage Object Create A .NET6 Minimal API Project: Let's create a .Net6 Minimal API sample project 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 For Minimal API Project dotnet new webapi -minimal -o Your_Project_Name Create A Third Party API Response Model: Here I'm going to use a free third-party rest API that is "https://jsonplaceholder.typicode.com/posts". So to receive the response let's create a response model like 'Post.cs'. Program.cs:(Add Post.cs c

.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