Skip to main content

An Overview On Hot Chocolate GraphQL Implementation In Pure Code First Approach

In this article, we are going to understand Hot Chocolate GraphQL implementation in pure code first approach.

GraphQL:

GraphQL is an open-source data query and manipulation and language for APIs. It is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like .Net, Java, NestJS, etc and it isn't tied to any specific database or storage engine and instead backed by your existing code and data.

GraphQL 2 main operations:
  • Query(fetching data)
  • Mutation(saving or updating data)

An Overview On GraphQL SDL(Schema Definition Language):

In GraphQL queries or mutations made up of Schema Definition Language. This SDL syntax looks similar to a javascript object. But as a c# developer no need to learn this SDL, Hot Chocolate library makes our learning path very easy in this case. So this section is to get the basic idea of the SDL.

GraphQL schema objects are created by using the 'type' keyword. So comparing with object-oriented programing 'type' keyword equals the 'class' keyword. GraphQL schema object posses scalar types like 'Int', 'String' etc.
type Person{
Id: Int,
Name: String
}
  • The 'Person' is GraphQL SDL object type. It contains properties is like 'Id' of type 'Int' and 'Name' of type 'String'.
GraphQL SDL syntax to define the Query type:
type Query{
 person:Person
}
  • The 'Query' type is an entry to fetch the data. It contains all resolvers(methods to fetch data)
  • Here we defined 'person: Person' means on requesting a 'person' query, we get the response of a single object type of 'Person'.
GraphQL SDL syntax to define the Mutation type:
type Mutation{
 create(person:PersonInput):Person
}
  • The 'Mutation' type is an entry to save or update the data. It contains all resolvers(methods to save or update the data).
  • The 'create' is the resolver that saves the data to the database.
GraphQL SDL syntax to define the Schema type:
type Schema{
 query: Query,
 mutation: Mutation
}
  • Schema is the root type in GraphQL where 'Query' and 'Mutation' registered.

Hot Chocolate GraphQL:

Hot Chocolate is an open-source GraphQL server that is compliant with the newest GraphQL latest specs. It is the wrapper library of the original .Net GraphQL library. Hot Chocolate takes the complexity away from building a fully-fledged GraphQL server.

Hot Chocolate provides 3 different techniques:
  • Schema First
  • Code First
  • Pure Code First
Schema Fist: This approach fully involve writing GraphQL SDL.

Code First: No schema writing, but every plain c# class should have mapping GraphQL c# class.
Click the below links to know more about the code first implementation.

Pure Code First: No schema writing, no GraphQL c# classes, only plain c# classes are enough. This approach is very simple, schema generation is taken care of by the GraphQL server behind the scenes.

Create A .Net5 Web API Application:

Now to begin our sample, we have to create .Net5 Web API application, then we will configure the GraphQL server. For development any IDE can be used, the most recommended are Visual Studio 2019(Version 16.8.* that supports .Net5) and Visual Studio Code.

Install Hot Chocolate GraphQL Library:

Package Manager Command:
Install-Package HotChocolate.AspNetCore -Version 11.0.9
.Net CLI Command:
dotnet add package HotChocolate.AspNetCore --version 11.0.9

Register GraphQL Server And Endpoint:

In 'Startup.cs' we have to register the GraphQL server.
Startup.cs:(ConfigureService Method)
services.AddGraphQLServer();
In 'Startup.cs' we have to register the GraphQL endpoint. By default GraphQL endpoint provides a default path like '/graphQL'. The path of the GraphQL endpoint can be overridden if needed.
Startup.cs:(Configure Method)
app.UseEndpoints(endpoints =>
{
	endpoints.MapGraphQL();
	endpoints.MapControllers();
});

Configure EntityFrameworkCore Database Context:

Let's integrate entity framework database context into our sample application to deal with data from the database.

let's install an entity framework NuGet package
Package Manager Command:
Install-Package Microsoft.EntityFrameworkCore -Version 5.0.4
.Net CLI Command:
dotnet add package Microsoft.EntityFrameworkCore --version 5.0.4
Now install entity framework core SQL server extension Nuget. 
Package Manager Command:
Install-Package Microsoft.EntityFrameworkCore.SqlServer -Version 5.0.4
.Net CLI Command:
dotnet add package Microsoft.EntityFrameworkCore.SqlServer --version 5.0.4
I have table 'Gadgets' in my local SQL server. So here I'm going to use code first with the existing database.

So let's create a folder like 'Data/Entities' where we can create all the POCO classes for SQL server tables. Now create a class like 'Gadgets.cs' in the 'Data/Entities' folder.
Data/Entities/Gadget.cs:
namespace GQL.PureCodeFirst.Data.Entities
{
    public class Gadgets
    {
        public int Id { get; set; }
        public string ProductName { get; set; }
        public string Brand { get; set; }
        public decimal Cost { get; set; }
        public string Type { get; set; }
    }
}
Create a class to define the database context inside the 'Data' folder.
Data/MyWorldDbContext.cs:
using GQL.PureCodeFirst.Data.Entities;
using Microsoft.EntityFrameworkCore;

namespace GQL.PureCodeFirst
{
    public class MyWorldDbContext : DbContext
    {
        public MyWorldDbContext(DbContextOptions<MyWorldDbContext> options) : base(options)
        {

        }
        public DbSet<Gadgets> Gadgets { get; set; }
    }
}
Add connection string inside the app settings file.
appsettings.Development.json:
"ConnectionStrings":{
  "MyWorldDbConnection":"Your_database_Connection_String"
}
Register database context(MyWorldDbContext.cs) in startup file
Startup.cs:
services.AddDbContext<MyWorldDbContext>(options =>
{
	options.UseSqlServer(Configuration.GetConnectionString("MyWorldDbConnection"));
});

Create A GraphQL Query Resolver:

Now let's create a Query class like 'QueryResolver.cs'. This file will have all resolvers or methods to fetch data.
Resolvers/QueryResolver.cs:
using System.Linq;
using GQL.PureCodeFirst.Data.Entities;
using HotChocolate;


namespace GQL.PureCodeFirst.Resolvers
{
    public class QueryResolver
    {

        public Gadgets FirstGadget([Service] MyWorldDbContext context)
        {
            return context.Gadgets.FirstOrDefault();
        }
    }
}
  • The 'QueryResolver' class represents GraphQL 'Query' type.
  • The 'FirstGadget' is our resolver or method that returns an object of type 'Gadgets'.
  • The 'HotChocolate.Service' attributes help to inject any kind of service. Here we injecting our 'MyWorldDbContext'.
Now we need to register our 'QueryResolver' in 'Startup.cs' with GraphQL server using the 'AddQueryType' extension method.
Startup.cs:
services.AddGraphQLServer()
.AddQueryType<QueryResolver>();
So on runtime GraphQL server will generate Query SDL like:
type Query{
  firstGadget: Gadgets
}

type Gadgets{
   id,
   productName,
   brand,
   cost,
   type
}
  • In c# our resolver method name is like 'FirstGadget', GraphQL on schema generation resolver method names follow pascal case, so it generates like 'firstGadget'. The client should use pascal case names while invoking the endpoint.
  • The c# 'Gadgets' will be generated as 'Gadgets' but its fields will be generated as in pascal case notation.
So let's frame a  query to consume from the newly created resolver.
query {
  firstGadget{
    id,
    productName,
    brand,
    cost,
    type
  }
}
  • Here 'query' keyword represents the type of the operation.
  • The 'firstGadget' is the name of the resolver name but should be in pascal casing.
  • The beauty of GraphQL is we can request only the required properties. In response, will contains only those props
Now run the application and navigate to the path "/graphql" and test our query framed above.

Create Query Method To Fetch Multiple Records:

Now let's add a new resolver method that will return a collection of records.
Resolvers/QueryResolver.cs:
public List<Gadgets> FetchAllGadgets([Service] MyWorldDbContext context)
{
	return context.Gadgets.ToList();
}
On runtime, GraphQL generates SDL like:
type Query{
  firstGadget: Gadgets
  fetchAllGadgets:[Gadgets]
}
Now let's test this resolver with few props in the request to understand how Graphql will make the response body very light with only the requested props

Aliases:

By default, GraphQL uses the resolver name from the query request to return the response with the property of the same name. If we carefully observe the previous response object you can find property names like 'fetchAllGadgets', 'firstGadget'. So to override the property name in the response object we can use the 'Aliases' concept in the Graphql.

Let's frame GraphQL query with aliases.
query {
  Gadgets:fetchAllGadgets{
    id,
    productName
  }
}
Here 'Gadgets' will be the alias name for the original 'fetchALLGadgets'.

Query Arguments To Filter Data:

Create a new resolver to return the filtered data.
Resolvers/QueryResolver.cs:
public List<Gadgets> FilterByBrand([Service]MyWorldDbContext context, string brand)
{
	if (string.IsNullOrEmpty(brand))
	{
		return new List<Gadgets>();
	}
	return context.Gadgets.Where(_ => _.Brand.ToLower() == brand.ToLower()).ToList();
}
On runtime Query schema generated like:
type Query{
  firstGadget: Gadgets,
  fetchAllGadgets:[Gadgets],
  filterByBrand(brand:String):[Gadgets]
}
Now let's frame the query to consume the resolver with an input filter.
Query:
query($brandQuery:String){
  filterByBrand(brand:$brandQuery){
    id,
    productName
  }
}
  • Here '$brandQuery' means GraphQL variable type. GraphQL variable type always starts with '$'.
  • The 'String' represents the type of value holds by the '$brandQuery'.
  • The 'brand' name should match with the input parameter name of the resolver method.
Variable:
{
  "brandQuery":"One Plus"
}
  • The GraphQL variables are used to pass the data dynamically to the GrphQL query. Here property name should be matched with variable type in query excluding the '$'.
Now run the application and consume the resolver with a filter.

Comparison Query And Fragment Query:

Fetching the data for comparison is very simple in GrapQL

Let's frame query to fetch comparison data without using 'Fragments'
Query:
query($brandQuery:String,$brandQuery2:String){
 Gadget1: filterByBrand(brand:$brandQuery){
    id,
    productName
  }
 Gadget2: filterByBrand(brand:$brandQuery2){
    id,
    productName
  }
}
  • Here we invoking resolver 2 times from the single 'Query'. So the server will respond with two results sets in the JSON.
Variable:
{
  "brandQuery":"One Plus",
  "brandQuery2":"Samsung"
}
Now test our comparison query.

Here in GraphQL endpoint, we are getting comparison data in a perfect way without doing any work at the server-side. But if we carefully observe the client request queries constructed with duplicate fields, which will be tedious, if the fields are high in number.

So to resolve these duplicate fields, GraphQL provided an option called fragments, a set of the similar fields will be grouped to set.

Let's frame the client comparison query using fragments.
Query:
query($brandQuery:String,$brandQuery2:String){
 Gadget1: filterByBrand(brand:$brandQuery){
    ...props
  }
 Gadget2: filterByBrand(brand:$brandQuery2){
    ...props
  }
}

fragment props on Gadgets{
  id,
  productName
}
  • Here keyword 'fragment defines our query fields are grouped by fragment query. Following the 'fragment' keyword we have to specify the name of our grouped properties like 'props(this name can be your choice). Next, we need to define the original type of those grouping properties like 'Gadgets'. Inside 'fragment needs to define all properties we want to group.
  • Now in Query type instead of defining each property multiple times, we can define the name of the fragment like 'props', but this 'props' name should be prefixed with triple dots(...props).
Variable:
{
  "brandQuery":"One Plus",
  "brandQuery2":"Samsung"
}

Create Mutation Resolvers:

In GraphQL mutations are to save or update the data. So let's create a new file like 'MutationResolver.cs' in the 'Resolvers' folder.
Resolvers/MutationResolver.cs:
using GQL.PureCodeFirst.Data.Entities;
using HotChocolate;

namespace GQL.PureCodeFirst.Resolvers
{
    public class MutationResolver
    {
        public Gadgets Save([Service]MyWorldDbContext context, Gadgets model)
        {
            if(model == null){
                return null;
            }
            context.Gadgets.Add(model);
            context.SaveChanges();
            return model;
        }
    }
}
Now we have to register our 'MutationResolver.cs' in 'startup.cs' file with GraphQL server using 'AddMutationType' extension method.
Startup.cs:
services.AddGraphQLServer()
.AddQueryType<QueryResolver>()
.AddMutationType<MutationResolver>();
Now on runtime GraphQL server generate Mutation schema like:
type Mutation{
	save(model:GadgetsInput):Gadgets
}
  • Here if we can observe in our MutationResolver class 'Save' method has the same object as 'Gadgets' for input payload and return type. But in schema generation, the input type generates as 'GadgetsInput'. GraphQL by default appends the 'Input' string to the name of the class(ex: GadgetsInput) to generate the payload object name.
Now, let's frame the client-side mutation to save data.
Mutation:
mutation ($myGadgets:GadgetsInput){
  save(model: $myGadgets){
    id,
    productName,
    brand,
    cost,
    type
  }
}
Variable:
{
  "myGadgets":{
    "productName":"Samsung Galaxy F62",
    "brand":"Samsung",
    "cost":10000,
    "type":"mobile"
  }
}
Let's test mutation operation to save data.
So that about a small overview on Hot Chocolate GraphQL core operations in Pure Code First.

Video Session:

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information Pure Code First technique in Hot Chocolate GraphQL. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

  1. I want to dynamically create the QueryType as in when user add new table/change schema.
    Do you know any idea on how to do this via hotchocoloate.I am unable to find the reference.

    ReplyDelete
  2. Hi Naveen,

    Your blogs are very helpful, Thanks for it. I have one issue in my project.

    Am unable to make db connection on second time hit when am using Resolver Class with GraphQL Type. On first time Resolver class constructor is invoking so am able to make connection where as next time constructor is not invoking. How can we handle this issue?

    ReplyDelete
    Replies
    1. Hi
      Don't inject at constructor level
      Inject per resolver , check my blog i did same

      Delete
  3. Thanks for reply,
    Yes if I added in method level like ABC([Service] IMyRepo myRepo) its working but I dont want pass/inject that to each method in the resolver class.

    ReplyDelete
    Replies
    1. Hi
      yes it won't work constructor injection because AddQueryType scope is singleton , and our dbcontext default registration 'scoped'(means per request) so from 2nd request dbcontext will empty because 'YourQueryResolver' is singleton(means once object created it won't be destroyed untill application stopes)


      So HotChocolate GraphQL recomend us to us inject dbcontext at method levels
      but if you still want constructor level

      The do like this
      AddScoped().
      AddQueryType ()

      so here we explicitly registering our 'YourQueryResolver' class as 'Scoped' means it new object will be created for every user request

      Official doc
      https://chillicream.com/docs/hotchocolate/api-reference/dependency-injection

      Delete
  4. 0


    How i can implement the Hot Chocolate GraphQL method versioning similar like to REST, i.e. /graphql/v1 or using request header. i don't want to use Deprecating fields because there is no any change in input or out param but i have change in method implementation(business wise).

    ReplyDelete

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