Skip to main content

NestJS API Integration With GraphQL Using Code First Approach


What Is GraphQL?:

GraphQL is a query language for your API and a server-side runtime for executing queries by using a schema type system you defined for your data. GraphQL is not tied to any specific programming language(like NestJS, Java, .NET, etc) or database or storage engine.

How GraphQL Different From Rest API:

  • GraphQL exposes a single endpoint.
  • Http-Post is the only Http verb recommended by supported by GraphQL API.
  • Client applications(consumers of GraphQL API) can give instructions to GraphQL API about the response data.

Code First vs Schema Approach:

Code First Approach:

In Code First Approach we use Typescript class to which need to apply GraphQL decorator on top of classes and also on top of properties inside of the class. These decorators help to auto-generate the raw GraphQL Schema. So in Code First Approach we no need to learn or concentrate to write the GraphQL Schema.

Schema First Approach:

GraphQL SDL(schema definition language) is a new syntactic query type language, in this approach which we need to learn new kinds of syntax. Click here to explore NestJS GraphQL Schema First Approach.

Create NestJS Application:

We will walk through with a simple NestJS Application to integrate GraphQL API in Code First Approach.
NestJS CLI Installation Command:
npm i -g @nestjs/cli
NestJS Application Creation Command:
nest new your-project-name

Install GraphQL Packages:

Let's install the following GraphQL supporting packages for the NestJS application.
1. npm i --save @nestjs/graphql
2. npm i --save graphql-tools
3. npm i --save graphql
4. npm i apollo-server-express

Define Object Type:

In Code First Approach we define Object Types which will generate the GraphQL Schema automatically. Each Object Type we define should represent the application domain object(means table of our database).

Let's define an Object Type class in our application as below.
src/cow.breeds/cow.breeds.ts:
import { ObjectType, Field, Int } from '@nestjs/graphql';

@ObjectType()
export class CowBreed {
  @Field(type => Int)
  id: number;
  @Field()
  name: string;
  @Field(type => Int, { nullable: true })
  maxYield?: number;
  @Field(type => Int, { nullable: true })
  minYield?: number;
  @Field({ nullable: true })
  state?: string;
  @Field({ nullable: true })
  country?: string;
  @Field({ nullable: true })
  Description?: string;
}
  • By decorating class with '@ObjectType()' decorator makes class as GraphQL Object Type. Every property to be registered with '@Fied()' decorator. 
  • This '@Field()' decorator comes with different overloaded options which help to explicitly define property type and whether the property is nullable or not. 
  • TypeScript types like 'string' and 'boolean' are similar to GraphQL types, so for those types we no need to explicitly defined the type of the property in '@Field()' decorator, but other TypeScript types like number, complex type are not understand by the GraphQL '@Field()' decorator, in that case, we need to explicitly pass the type using arrow function like '@Field(type => Int)'. 
  • Similarly explicitly defining property is nullable by inputting as an option to decorator like '@Field({nullable:true})'.
  • GraphQL Schema will be generated based on this ObjectType class automatically which we explore in upcoming steps.

Service Provider:

In general service provider contains logic to communicate with the database and fetches the data to serve. In this sample, we are not going to implement any database communication, but we will maintain some static data in the service provider class as below.
src/cow.breeds/cow.breed.service.ts:
import { CowBreed } from './cow.breed';
export class CowBreedService {
    cowBreeds: CowBreed[]=[{
        id : 1,
        name: "Gir",
        maxYield:6000,
        minYield:2000,
        country: "India",
        state: "Gujarat",
        Description:"This breed produces the highest yield of milk amongst all breeds in India. Has been used extensively to make hybrid 	     v         varieties, in India and in other countries like Brazil"
    }];
	// while testing add more items in the list

    getAllCows(){
        return this.cowBreeds;
    }

    getCowById(id:number){
        return this.cowBreeds.filter(_ => _.id == id)[0];
    }
}
Now register this newly created service provider in the app.module.ts file.
import { CowBreedService } from './cow.breeds/cow.breed.service';

@Module({
  providers: [CowBreedService],
})
export class AppModule {}

Resolver:

Resolver is used to implement GraphQL operations like fetching and saving data, based default GraphQL Object Types like  'Query' Object Type(contains methods for filtering and fetching data), 'Mutation' Object Type(contains methods for creating or updating data).

Let's create a resolver class with Query Object Type as below.
src/cow.breeds/cow.breed.resolver.ts: 
import {Resolver, Query, Args, Int} from '@nestjs/graphql';
import { CowBreedService } from './cow.breed.service';
import {CowBreed} from './cow.breed';

@Resolver()
export class CowBreedResolver {
  constructor(private cowBreedService: CowBreedService) {}

  @Query(returns => [CowBreed])
  async getAllCows(){
    return await this.cowBreedService.getAllCows();
  }

  @Query(returns => CowBreed)
  async getCowById(@Args('id',{type:() => Int}) id:number){
    return await this.cowBreedService.getCowById(id);
  }
}
To make typescript class resolver need to decorate the class with '@Resolver'. '@Query()' decorates defines the method as Query Object Type methods. Here we decorated '@Query()' to the methods which return the data. In Code First Approach inside '@Query()' decorator needs to pass the return type of the data([CowBreed] represents GraphQL array type return the array of CowBreed). Inside the resolver, methods input parameters decorated with '@Args' type to capture the client passed values.

Now register resolver entity in providers array in app.module.ts file.
app.module.ts:
import {CowBreedResolver} from './cow.breeds/cow.breed.resolver';

@Module({
  providers: [CowBreedResolver],
})
export class AppModule {}

Import GraphQLModule:

Let's import GraphQLModule into the app.module.ts.
app.module.ts:
import { GraphQLModule } from '@nestjs/graphql';
import {join} from 'path';

@Module({
  imports: [
    GraphQLModule.forRoot({
      autoSchemaFile:(join(process.cwd(),'src/schema.gql'))
    })
  ],
})
export class AppModule {}
Inside GrphQLModule pass the schema file path('src/schema.gql') where all our application auto-generated schema will be stored. So we need to create a schema file 'schema.gql' as below.
Let's run the NestJS application
NestJS Development Run Command:
npm run start:dev
Now very the way GraphQL Schema Generated automatically as below

GraphQL UI PlayGround:

GraphQL UI Playground is the page which helps as a tool to query our GraphQL API. This Playground gives Schema information, GraphQL Documentation, Intelligence to type the queries more quickly. GraphQL constructed only one endpoint and supports only Http Post verb, so to access this UI Playground simply use the same endpoint in the browser directly.

Fields:

GraphQL is about asking for specific fields on objects on the server. Only requested fields will be served by the server.
Let's query a few fields as follows.
query{
  getAllCows{
    name
    state
    country
  }
}
  • 'query' keyword to identify the request is for fetching or querying data based on 'Query Object Type' at the server. 
  • 'getAllCows' keyword to identify the definition or method inside of the 'Query Object Type'. 
  • 'name', 'state', 'country' are fields inside of the 'CowBreed' GraphQL object type we created. 

Input Argument To Filter Data:

In GraphQL we can pass arguments to filter the Data. Let's construct the query as below with a filtering argument.
query{
  getCowById(id:2){
    id,
    name,
    state,
    country,
    Description
  }
}

Aliases:

While querying the GraphQL API with schema definition names like 'getAllCows', 'getCowById' are more self-explanatory, which good for requesting the API. But API on returning a response uses the same definition name as main object name which looks bit different naming convention for JSON response object. In GraphQL to overcome this scenario, we can use 'Aliases' names which are defined by the client, the API will serve the response with those names.
query{
   Cows:getAllCows{
    name
    state,
    country,
    Description
   }
}

Fragments:

Fragments in GraphQL API mean comparison between two or more records. A comparison between 2 or more items is very easy in GraphQL.
query{
   Cows1:getCowById(id:1){
    name
    state,
    country,
    Description
   }
  Cows2:getCowById(id:1){
    name
    state,
    country,
    Description
   }
  Cows3:getCowById(id:1){
    name
    
   }
} 
Defining a schema definition payload multiple times inside of the query object is called Fragments. The fragment is only possible between the same type of schema definition if you try to execute between different schemas that lead to error. In each definition you can define any number of field names, it is not mandatory to define the same number field names in all definitions as in the above query.

Mutation:

GraphQL Mutation object type deals with data updates. All the definitions in the Mutation object type have the responsibility of saving or updating the data to storage (like a database).

For saving data in the Mutation object type definition we need to pass an argument that should be an object. In GraphQL to create an argument object, we need to construct an object type as follows.
src/cow.breeds/cow.breed.input.ts:
import { Int, Field, InputType } from '@nestjs/graphql';
@InputType()
export class CowBreedInput {
  @Field(type => Int)
  id: number;
  @Field()
  name: string;
  @Field(type => Int, { nullable: true })
  maxYield?: number;
  @Field(type => Int, { nullable: true })
  minYield?: number;
  @Field({ nullable: true })
  state?: string;
  @Field({ nullable: true })
  country?: string;
  @Field({ nullable: true })
  Description?: string;
}
In NestJS GraphQL using '@Args()' decorator can capture the input values from the client, but in 'Mutation Object Type' queries involved in the creation or update of data which involves in more number of properties. So to capture the complex object of data using '@Args()'  we need to create a class and it should be decorated with '@InputType'.
Hint:
'ObjectType()' decorator are only used to represent the domain object of the application(database tables). 'ObjectType()' can not used to capture the data from client. So to capture the data from the client we need to use 'InputType()' Object Types.
Let's update service provider logic to save a new item as below.
src/cow.breeds/cow.breed.service.ts:
export class CowBreedService {
    // hidden code for display purpose
    addCow(newItem:any):CowBreed{
        this.cowBreeds.push(newItem);
        return newItem;
    }
}
Now define a 'Mutation Object Type' query in resolver class as follows.
src/cow.breeds/cow.breed.resolver.ts:
import {CowBreedInput} from './cow.breed.Input';

@Resolver()
export class CowBreedResolver {
  // hidden code for display purpose
  @Mutation(returns => CowBreed)
  async addCow(@Args('newCow') newCow:CowBreedInput){
    var cow = await this.cowBreedService.addCow(newCow);
    return cow;
  }
}
Let's run the application and check autogenerated GraphQL Schema for Mutation Object Type.
Now to post the data from the client to GraphQL API, the client uses a syntax called GraphQL variables, these variables take JSON Object as input data. 
mutation($newCow:CowBreedInput!){
  addCow(newCow:$newCow){
    id,
    name,
    maxYield,
    minYield,
    state,
    country,
    Description
  }
}

{
  "newCow": {
    "id": 4,
    "name": "Hallikar",
    "maxYield": null,
    "minYield": null,
    "state": "Karnataka",
    "country": "India",
    "Description": "Draught breed both used for road and field agricultural operations. Closely related to Amrit Mahal. However, are much thinner and produce low yields of milk."
  }
}

Wrapping Up:

Hopefully, this article will help to understand the GraphQL API integration in the NestJS application using Code First Approach. I love to have your feedback, suggestions, and better techniques in the comment section.

Refer:

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

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