Skip to main content

NestJS API CRUD Operations With MongoDB


Introduction:

NestJS is a framework used to develop server-side applications. NestJS built on top of Node.js frameworks like Express. It is a combination of Progressive Javascript, Object-Oriented Programming, Functional Programming, and Functional Reactive Programming.

Nest CLI Installation:

Using Nest CLI we are able to generate the NestJS starter project with the default template. To install Nest CLI globally over our system open command prompt and run the command

             npm i -g @nestjs/cli

Now create a sample project by using Nest CLI command

             nest new your_project_name

package.json:

Now open the package.json file from the sample application created, you can observe few properties like "scripts", "dependencies", and "devDependencies".

"dependencies" contains all plugins to be installed and used them to run the application.

"devDependencies" contain all plugins to be installed and used them at the time of application development.

"scripts" contains a set of commands to build, run and test the application.

Run NestJS Application:

Now to run the application you can find commands in package.json as below
you can observe different modes of the application start commands. Now open a command prompt at package.json physical path and run the command

         npm run start

Now application gets run on port 3000, can check by navigating to "http://localhost:3000/".

main.ts:

"main.ts" is an application startup file. Here application startup module(AppModule) gets loaded using NestFactory. An application running port can be defined in the main.ts file. Hereby default application port configured to 3000 port.

app.module.ts:

Modules are used to separate code for easy maintenance and to follow good coding standards. NestJS application can have many modules, but AppModule is the parent of any module in the application.
AppModule gets invoked by the main.ts file on application start.

AppModule holds of "imports(imports modules either application or third-party library modules)", "controllers", and "providers" etc.

Create Controllers:

Controllers are responsible for accepting the incoming requests and send the response to the client. In NestJS controller is plain class which is decorated with "@Controller()" decorator on top of the class.
@Controller() is derived from the "@nestjs/common" plugin. @Controller('my_route_value') takes string input value is the route to that controller. Controllers contain a set of action methods, these action methods are responsible for servicing the request to the client by connecting to data sources like database, files, etc.

Now create a new folder name it as "ExtinctAnimals", then inside of folder create the controller and name it as "extinct.animals.controller.ts" and then add a class in that file on top of the class use controller decorator "@Controller('extinctanimals')" with route 'extinctanimals'. Now, this NestJS API end-point can be accessed as "http://localhost:3000/extinctanimals".

MongoDB:

NestJS supports both Relational and Non-Relational databases. MongoDB is a Non-Relational database, which stores data as documents. Click here to getting started with MongoDB.

mongoose and @nestjs/mongoose:

Using Mongoose NestJS plugins, the application can interact with MongoDB. To install the mongoose plugin run the following command

npm install --save @nestjs/mongoose

npm install --save mongoose

Import MongooseModule:

To connect NestJS application with MongoDB, import "MongooseModule" from "@nestjs/mongoose". MongooseModule.forRoot('your_mongo_connection') need to be imported into the app.module.ts file. Here module is expecting connection as input parameter of MongooseModule.forRoot().

import { MongooseModule } from '@nestjs/mongoose';
@Module({
  imports: [MongooseModule.forRoot("mongodb://localhost:27017/MyWorldDatabase")],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

MongoDB connection string "mongodb://localhost:27017" is postfix with database name "MyWorldDatabase".

Mongoose Schema Mapping:

To communicate with MongoDB Collections(Tables) need to map their collection schema with NestJS application Models. Now create folder name as "schema" and add filename as "extinct.animal.schema.ts" and below code into that file.

import * as mongoose from 'mongoose';

export const extinctAnimalSchema = new mongoose.Schema({
    Name:String,
    Location:String,
    ExtinctYear:Number
},{
    versionKey:false
});  

"ExtinctAnimals" is the collection in my  MongoDB, schema mapping done by using new mongoose.Schema({}) 

"versionKey" - by default using NestJS creating a document in MongoDB, it adds extra column "_v" is versioning to the document. To avoid adding this property in document, disable versioning by setting false.


Create Model:

Now add a new folder "models", in that add filename as "extinct.animals.model.ts" and add the following code below
export interface ExtinctAnimal{
    Name:String,
    Location:String,
    ExtinctYear:Number
} 

Update Model Schema To AppModule:

Register our schema "extinctAnimalsSchema" into the app module by using MongooseModule.forFeature([]). By registering schema here, we can access it by injecting them in services where we going to write logic to communicate MongoDB. The "collection" property should match with the MongoDB Collection Name(Here using 'ExtinctAnimals' collection name). Update app.module.ts file as below


import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';

import { MongooseModule } from '@nestjs/mongoose';
import { extinctAnimalSchema } from './Schemas/extinct.animals.schema';

@Module({
  imports: [
    MongooseModule.forFeature([{
      name:'ExtinctAnimals',
      schema:extinctAnimalSchema,
      collection:'ExtinctAnimals'
    }]),
    MongooseModule.forRoot("mongodb://localhost:27017/MyWorldDatabase")
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}
  

Create Service:

Now add a new folder name as "Services", then create a new file in that folder and name as "extinct.animal.service.ts".

To make a service file to access by constructor injection, decorate the service class with "@injectable()" decorator provided by "@nestjs/common".

In general "Service" file holds logic to communicate with database calls. Since we are using MongoDB as a database, each service file holds logic to "Collection(Table)" to do that schema that we have created in the above steps need to be injected as Model type(MongoDB Collection Type) through a constructor.

"InjectModel('your_mongoDB_collectionName')" from "@nestj/mongoose" helps to map the schema to MongoDB Collection(Table). The input to string "InjectModel()" should be matched with the one of the name registered in MongooseModule.forFeature([]) in appmodule.


import {Injectable} from '@nestjs/common';
import {Model} from 'mongoose';
import {InjectModel} from '@nestjs/mongoose';
import {ExtinctAnimal} from '../Models/extinct.animals.model'

@Injectable()
export class ExtinctAnimalService{
  constructor(@InjectModel('ExtinctAnimals') private readonly extinctAnimalModel: Model<ExtinctAnimal>){}
}

Now "extinctAnimalModel" variable is  act as collection in MongoDB.

Now add code in "extinct.animals.service.ts" file, to get all the documents from "ExtinctAnimals" collection in MongoDB 
  async getAll(){
      return await this.extinctAnimalModel.find();
  }

Update AppModule With Service and Controllers:

We have to import all our controllers and services to AppModule as below
  import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';

import { MongooseModule } from '@nestjs/mongoose';
import { ExtinctAnimalsController} from './ExtinctAnimals/extinct.animals.controller';
import { extinctAnimalSchema } from './Schemas/extinct.animals.schema';
import {ExtinctAnimalService} from './Services/extinct.animals.service';

@Module({
  imports: [
    
    MongooseModule.forRoot("mongodb://localhost:27017/MyWorldDatabase"),MongooseModule.forFeature([{
      name:'ExtinctAnimal',
      schema:extinctAnimalSchema,
      collection:'ExtinctAnimals'
    }])
  ],
  controllers: [AppController,ExtinctAnimalsController],
  providers: [AppService,ExtinctAnimalService],
})
export class AppModule {}


Read Action Method:

Create an action method in "extinct.animals.controller.ts" file, to request all the documents from MongoDB. Action method will be decorated with HTTP verbs like '@Get()', '@Post', '@Delete', etc to determine the action method type. These HTTP verbs can contain route value if needed as an input parameter.

  import {Controller,Get} from '@nestjs/common';
import {ExtinctAnimalService} from '../Services/extinct.animals.service';

@Controller('extinctanimals')
export class ExtinctAnimalsController{
  constructor(private service:ExtinctAnimalService){}
  @Get('all')
  async GetAll(){
    return await this.service.getAll();
  }
}

ExtinctAnimalService injected into the controller, we have added route value to "@Get('all')" HTTP verb. Now try to navigate to "http://localhost:3000/extinctanimals/all"

Create Action Method:

"Mongoose" provided a "save()" method on an injected Model to create a new document in MongoDB. 

Create action method that will be decorated with "@Post('add')" Http verb with the route as an input parameter. 

Since the post method will return nothing we can assign a "201" status code. In NestJS status codes can be defined as a decorator on top of action method like "@HttpCode(201)"

Data posted to the controller will be received by action method by prefixing "@Body()"  to the input object

Update the file "extinct.animals.service.ts" file with below code
  async add(animal){
    const createAnimal = new this.extinctAnimalModel(animal);
    await createAnimal.save();
  }

Update the file "extinct.animals.controller.ts" with below code
import {Controller,Get,Post,Body} from '@nestjs/common';
  @Post('add')
  async Add(@Body() animal:any){
      await this.service.add(animal);
  }

To test post method use google postman

Update Action Method:

"Mongoose" provided methods like "updateOne()" for single update and "updateMany()" for multiple updates on conditionally. This update method takes parameters like conditions and the new objects to be updated.

Update the file "extinct.animals.service.ts" with following code
  async update(animal){
    await this.extinctAnimalModel.updateOne({ExtinctYear:animal.ExtinctYear},animal);
  }

Update the file "extinct.animals.controller.ts" with following code
  @Post('update')
  async Update(@Body() animal:any){
    await this.service.update(animal);
  }

Delete Action Method:

"Mongoose" provided methods like "deleteOne()" for deleting single document and "deleteMany()" for deleting multiple documents.

"@param()" is used to capture the routing value in action methods. Optionally we can pass the name of the routing parameter as input to it like "@param('id')"

"@Delete()" Http verb to represent the action method type

Update the file "extinct.animals.service.ts" with the following code
  async delete(id){
    await this.extinctAnimalModel.deleteOne({_id :id});
  }

Update the file "extinct.animals.controller.ts" with the following code
 import {Controller,Get,Post,Body, Delete,Param} from '@nestjs/common';
import {ExtinctAnimalService} from '../Services/extinct.animals.service';

 
 @Delete('delete/:id')
  async Delete(@Param('id') id){
    await this.service.delete(id);
  }

Refer:

Part- Nestjs Jwt Authentication(Access Token Implementation)

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