Skip to main content

NestJS API Integration With GraphQL Using Schema 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 GraphQL.
  • Client applications(consumers of GraphQL API) can give instructions to GraphQL API about the response data.

Schema vs Code First Approach:

Schema First Approach - GraphQL SDL (Schema definition language) is a new syntax language, which is independent of any programming language and also integrates with any programming language. But while integrating with any programming language GraphQL Schema needs to be mapped with objects or classes or interface of the specific programming language to build communication between GraphQL Schema and programming language. In NestJS this communication channel will be built automatically by generating files in the form Typescript Classes or Interfaces based on the GraphQL schema define by you.

Code First Approach - In this approach TypeScript Classes and its fields use decorators on them which will generate corresponding GraphQL Schema automatically. Here we don't specify GraphQL SDL explicitly which helps developers to have less concentration on GraphQL Schema syntax.

Create NestJS Application:

Here we going to create a sample NestJS application with GraphQL integration using Schema first Approach.
NestJS Installation Command:
npm i -g @nestjs/cli
NestJS Application Creation Command:
nest new your-project-name

GraphQL NPM Packages:

Now run the following commands to install GraphQL packages required for our application.
1. npm i --save @nestjs/graphql
2. npm i --save graphql-tools
3. npm i --save graphql

Define GraphQL Schema:

GraphQL Schema is constructed by object types, most object types represent the domain object(domain object means a class or interface in an application that represents a table in the database). Query and Mutation are default object types of GraphQL Schema, these object types represent the operations like fetching or updating an API.

Now let's define GraphQL Schema object type that represents our application domain object as below.
src/student/student.grahpql(file extension *.grahql):
type Student{
    _id: String,
    FirstName: String,
    LastName: String,
    Standard: Int,
    FatherName: String,
    MotherName: String
}
  • The schema object type almost looks like a JSON object. 
  • The Schema object begins with 'type' keyword and 'Student' is the name we defined for the Schema object type. 
  • The Schema has a set of properties these must match with our domain object(class or interface in typescript represents a table in the database). 
  • GraphQL Schema has a set of pre-defined data types like 'Int', 'String', etc which looks similar to most of the programming language types.

Define GraphQL Schema Query Object Type:

The 'Query' object type is a default type in GraphQL Schema. 'Query' constructs all definitions to filter definitions of our API(simple words it contains all method definitions to filter and fetch data).

Let's define filter definitions for our 'Student' object type as below.
src/student/student.graphql(file extension *.graphql): 
type Query{
    getAllStudents:[Student],
    getStudentById(id:String):Student
}
  • GraphQL Schema Query object holds all the definitions for filtering API. 
  • 'getAllStudents()' definition to fetch all data and [Student](name should match with our GraphQL Schema object type we defined in an earlier step) represents an array of 'Student' object types. 
  • 'getStudentById(id:string)' definition to fetch single object type with matched input value 'id'.

Import GraphQLModule:

In AppModule of our application, we need to register the GraphQLModule as below.
src/app.module.ts:
import { GraphQLModule } from '@nestjs/graphql';
import { join } from 'path';

@Module({
  imports: [
    GraphQLModule.forRoot({
      typePaths: ['./**/*.graphql'],
      definitions:{
        path: join(process.cwd(),'src/graphql.schema.ts')
      }
    })
  ]
})
export class AppModule {}
// code hidden for display purpose
  • Inside import array registered 'GraphQLModule.forRoot({})' from '@nestjs/grahpql' library. 
  • 'GraphQLModule.forRoot({})' the module takes input configuration object with properties like 'typePaths', 'definitions'.
  • 'typPaths'  used to access all GraphQL Schema defined files and it takes collection of file paths as input. 
  • './**/*.graphql' defines folder paths to search for graphql files, './'(mostly represents 'src') root path, '/**/'  defines all folder and it subfolders, '*.graphql' all files inside the folders with '.graphl' file extension. 
  • 'definitions' takes an object which contains property like 'path', the use of this 'path' property to auto generate the typescript classes or interface based on the GraphQL object types. So for this 'path' property need specify location for '*.ts'(like 'src/grahql.schema.ts') generation.

Auto-Generated GraphQL Schema To Typescript Classes or Interfaces:

On application start, all the GraphQL Schema objects are collected and generates matching typescript classes or interface for build communication between typescript and GraphQL schema.

To check application start commands go to package.json file and check the scripts object inside it.
Development command to start the application:
npm run start:dev
On application started, the schema file gets crated as below.


On starting the application if the build fails as below
Then install the required package shown in the error above.
npm install apollo-server-express

Service Provider:

In general service provider contains logic to fetch the data from databases. Let's create a service provider with test data as follows.
src/student/student.service.ts:
import {Student} from '../graphql.schema';

export class StudentService {
        students:Student[]=[{
            _id:"abc1",
            FirstName: "Naveen",
            LastName: "Bommidi",
            Standard: 7,
            FatherName: "Gopala Krishna",
            MotherName: "Mallikasulamma"
        }]; // while testing graphql api add more test data

    getAllStudents():Student[]{
        return this.students;
    }

    getStudentById(id:string):Student{
        var filteredStudent = this.students.filter(_ => _._id === id)[0];
        return filteredStudent;
    }
}
'Student' type importing from auto-generated classes or interface based on the schema object type.

Now import service provider in app.module.ts file as follows.
app.module.ts:
import {StudentService} from './student/student.service';

@Module({
  providers: [StudentService],
})
export class AppModule {}
// code hidden for display purpose

Resolver:

Resolver is used to implement the GraphQL operation like fetching or saving data, based on default schema object types like 'Query'(contains definition for filtering and fetching data) or 'Mutation'(contains definition for creating or updating data).

Let's resolve the 'Query' object type in 'student.graphql' file as below.
src/student/student.resolver.ts:
import { Resolver, Query, Args } from '@nestjs/graphql';
import { StudentService } from './student.service';
import { Student } from '../graphql.schema';

@Resolver('Student')
export class StudentResolver {
  constructor(private studentService: StudentService) {}

  @Query()
  getAllStudents(): Student[] {
    return this.studentService.getAllStudents();
  }

  @Query()
  getStudentById(@Args('id') id: string):Student{
      return this.studentService.getStudentById(id);
  }
}
  • '@Resolver()' imported from '@nestjs/graphql' package, it should be decorated over the class to make it resolver class and it takes optional string input parameter where we pass the name of the GraphQL schema object type(eg: Student). 
  • '@Query()' imported from '@nestjs/graphql', this decorator represents the 'Query' object type in GraphQL Schema and it should be decorated over the implemented methods of the 'Query' object type
  • '@Arg()' is capture the input values from the clients.
Now import the resolver into the app.module.ts file as follows. app.module.ts:
import { StudentResolver } from './student/student.resolver';

@Module({
  providers: [StudentResolver],
})
export class AppModule {}
// hidden some code for display purpose

GraphQL UI Playground:

GraphQL UI Playground is the page which helps as a tool to query our GraphQL API (if we compare with REST API UI Playground is like Swagger). 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 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 from the 'Student' schema as follow.
query{
  getAllStudents{
    FirstName,
    LastName,
  }
}
  • 'query' keyword to identify the request is for fetching or querying data based on 'Query' Schema object at the server. 
  • 'getAllStudents' keyword to identify the definition or method inside of the 'Query' schema object. 
  • 'FirstName', 'LastName' are fields inside of the 'Student' GraphQL object type we created. 
From the above result image, API returns only requested fields and the definition or method name used as the response object name(eg: 'getAllStudents' returned response as an array of objects).

Input Arguments 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{
  getStudentById(id:"abc2"){
    FirstName,
    LastName,
    Standard
  }
}
In 'Query' object type we have a definition 'getStudentById' which takes an input parameter, the above query is to execute this definition.

Aliases:

While querying the GraphQL API with schema definition names like 'getAllStudents', 'getStudentById' 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{
  Student:getAllStudents{
    _id,
    FirstName
  }
}
Here 'Student' is the alias name for 'getAllStudents'.

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{
  LeftStudent:getStudentById(id:"abc1"){
    _id,
    FirstName
  }
  MidleStudent:getStudentById(id:"abc2"){
    _id,
    FirstName
  }
  RightStudent:getStudentById(id:"abc3"){
    _id,
    FirstName,
    LastName
  }
}
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 Schema to create an argument object, we need to construct an object type as follows.
src/student/student.graphql: 
input StudentInput{
    _id:String
    FirstName: String,
    LastName: String,
    Standard: Int,
    FatherName: String,
    MotherName: String
} 
Object type constructed with 'input' keyword is used for argument variable type for the definitions either in 'Query' or 'Mutation' object types.

Let's define the Schema definition in Mutation object type as follows
src/student/student.graphql:
type Mutation{
    create(student:StudentInput):Student
}
'StudentInput' is used to input argument for creating definitions.
Note:
You can't use 'Student' object type as an argument type in 'create' definition, because in graphql object get created by using 'input' keyword to use as an argument type.
Let's update the service provider class as follows.
src/student/student.service.ts:
import {Student} from '../graphql.schema';

export class StudentService {
 // code hidden for display purpose
    createStudent(newStudent:any):Student{
        this.students.push(newStudent);
        return newStudent;
    }
}

Let's now update the resolver class by implementing the 'create' definition in the Mutation object type as follows.
src/student/student.resolver.ts:
import {Args, Mutation } from '@nestjs/graphql';
import { StudentService } from './student.service';
import { Student, StudentInput } from '../graphql.schema';


@Resolver('Student')
export class StudentResolver {
  constructor(private studentService: StudentService) {}

  @Mutation()
  create(@Args('student')student:StudentInput):Student{
    return this.studentService.createStudent(student);
  }
}
In resolve class, while implementing the definition in 'Mutation' object type then we need to use '@Mutation()' decorator on top of the implemented method. 'StudentInput' class which auto-generated from GraphQL Schema to 'src/graphql-schema.ts' file.

Now to create GraphQL query to save a new item as follows
Mutation:
mutation($student:StudentInput){
  create(student:$student){
    _id,
    FirstName,
    LastName,
    Standard,
    MotherName,
    FatherName
  }
}
Variable:
{
  "student": {
    "_id": "abc4",
    "FirstName": "Rohit",
    "LastName": "Sharma",
    "Standard": 10,
    "FatherName": "Jagadesh",
    "MotherName": "Lalitha"
  }
}
This is a way to send data to save in graphql,  "student" in JSON object must match with the name with an input parameter of 'create()' method which means  'student' is GraphQL variable.
Test the new item added by using a query as follow.

Wrapping Up:

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

Refer:

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