Skip to main content

A CRUD Operation Demo With Blazor WebAssembly(.NET6) + Strawberry Shake GraphQL Client + MudBlazor UI + GraphQL API

In this article, we are to implement CRUD operation in Blazor WebAssembly(.NET6) by consuming GraphQL endpoint with help of  'Strawberry Shake'(Graphql Client Library).

GraphQL Endpoint:

In this demo, we have to consume the GraphQL endpoint from our Blazor WebAssembly application.

Strawberry Shake:

Strawberry shake is an open-source GraphQL client that is compliant with the newest GraphQL draft spec, which makes Strawberry Shake compatible with all GraphQL compliant servers like Hot Chocolate, Apollo Server, GraphQL Java, and various other servers out there.

Strawberry Shake will generate the schema of GraphQL Server which will help to invoke the GraphQL endpoint very easily.

Strawberry Shake CLI Tool:

Strawberry shake CLI needs to be configured because CLI will help us to generate the GraphQL client.

Create a folder where we are going to add our Blazor server application. In the same folder open the command prompt and run the below commands to configure the Strawberry Shake CLI.

Create a dotnet tool-manifest
dotnet new tool-manifest

Now install the Strawberry Shake CLI tool.
dotnet tool install StrawberryShake.Tools --local

Create A Blazor WebAssembly Application:

Let's create a Mudblazor template Balzor WebAssembly(.NET6) application. So using Mudblazor commands we can create a built-in templated project very easily without any external configuration.

Install Mudblazor Template into our system.
dotnet new --install MudBlazor.Templates

Now run the below command to create Blazor WebAssembly(.NET6) application along with default Mudblazor UI configuration.
dotnet new mudblazor --host wasm --name YourProjectName

Now run the project and the application looks as below.

Install Required NuGet Package:

Add the 'StrawberryShake.Transport.Http' NuGet.
Package Manager Command
Install-Package StrawberryShake.Transport.Http -Version 12.6.0

.NET CLI Command
dotnet add package StrawberryShake.Transport.Http --version 12.6.0

Add the 'StrawberryShake.CodeGeneration.CSharp.Analyzers' NuGet.
Package Manager Command
Install-Package StrawberryShake.CodeGeneration.CSharp.Analyzers -Version 12.6.0

.NET CLI Command
dotnet add package StrawberryShake.CodeGeneration.CSharp.Analyzers --version 12.6.0

Add the 'Microsoft.Extensions.DependencyInjection' NuGet.
Package Manager Command
Install-Package Microsoft.Extensions.DependencyInjection -Version 6.0.0

.NET CLI Command
dotnet add package Microsoft.Extensions.DependencyInjection --version 6.0.0

Add the 'Microsoft.Extensions.Http' NuGet.
Package Manager Command
Install-Package Microsoft.Extensions.Http -Version 6.0.0

.NET CLI Command
dotnet add package Microsoft.Extensions.Http --version 6.0.0

Generate GraphQL Client Using GraphQL Server Schema:

Strawberry Shake helps to generate a lot of boilerplate code like 'Schema'(Generates Server GraphQL schema into our blazor application), 'GraphQL Client'(this client class generated based on the schema, this client class contains all resolver methods of our server endpoint).

Now make sure our GraphQL endpoint server running.

Now let's run the Strawberry Shake command to generate the 'Schema'
dotnet graphql init https://YourDomain/graphql/ -n YourClientName -p ./YourFolderName
  • 'YourClientName' - Specify any name this will be used to generate a client class that will contain all predefined methods consuming the GraphQL endpoint.
  • 'YourFolderName' - Specify any name, a folder will be created that contains files like below.
In '.graphqlrc.json' file add the namespace property so that 'Client class' generated by the schema will use it.
Now add the same namespace into the '_Import.raozr'.
@using Dot6.StrawberyShake.Crud.Demo.CakeGqlSchema

Read Operation:

Now from the Blazor WebAssembly application, we have to invoke the GraphQL query to fetch all data.

Now inside of our schema generate folder let's add a file like 'GetAllCakes.graphql'.
CakeGqlSchema/GetAllCakes.graphql:
query GetAllCakes{
   allCakes{
     id
     name
     description
     price
   }
}
  • (Line: 1) The 'GetAllCakes' is the custom name. In a real GraphQL server query, we won't add, but here we add because using this naming method will be created inside of the 'Client Class'.
  • Here is the GraphQL query for fetching the collection of 'Cakes' from the server.
Now build the project and we can observe our GraphQL schema 'Client class' gets generated as below.

Now register our 'Client class' based HttpClient instance in the 'Program.cs'.
Program.cs:
builder.
Services.
AddCakeGql()
.ConfigureHttpClient(
client => client.BaseAddress = new Uri("https://localhost:7177/graphql/"));
  • The 'AddCakeGql()' method generated base on our 'Client class' name.
  • Here we configure our Server GraphQL endpoint.
Now let's create a response model for our GrapQL endpoint like 'Dtos/CakeDto.cs'
Dtos/Cake.Dto.cs:
namespace Dot6.StrawberyShake.Crud.Demo.Dtos;
public class CakeDto
{
    public int Id { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
    public string Description { get; set; }
}
Let's update our 'Index.razor' component to bind our sample GraphQL endpoint data.
Pages/Index.razor:(Html Part)
@page "/"
@inject CakeGql _cakeGql;
<MudGrid Justify="Justify.Center" class="pr-4 pl-4">
    @foreach (var cake in allCakes)
    {
        <MudItem xs="3">
            <MudCard>
                <MudCardHeader>
                    <CardHeaderContent>
                        <MudText Typo="Typo.body1">@cake.Name</MudText>
                        <MudText Typo="Typo.h6">@cake.Price $</MudText>
                    </CardHeaderContent>
                </MudCardHeader>
                <MudCardContent>
                    <MudText Typo="Typo.body2">@cake.Description</MudText>
                </MudCardContent>
                <MudCardActions>
                    <MudIconButton Icon="@Icons.Filled.Edit" Color="Color.Primary" />
                    <MudIconButton Icon="@Icons.Filled.Delete" Color="Color.Error" />
                </MudCardActions>
            </MudCard>
        </MudItem>
    }
</MudGrid>
  • (Line: 2) The 'CakeGql' (Client class generated by the Strawberry Shake) was injected into our 'Index.razor'.
  • (Line: 4) Looping the GraphQL API response data.
  • (Line: 10&11&15) Binding the GraphQL API response data.
Pages/Index.razor:(C# Part)
@code {
    List<CakeDto> allCakes = new List<CakeDto>();
    protected override async Task OnInitializedAsync()
    {
        var result = await _cakeGql.GetAllCakes.ExecuteAsync();
        allCakes =  result.Data.AllCakes.Select(c => new CakeDto
        {
            Description = c.Description,
            Id = c.Id,
            Name = c.Name,
            Price = c.Price
        }).ToList();
    }
}
  • (Line: 2) Initialized 'CakeDto' collection.
  • (Line: 3) The 'OnInitializedAsync' is a life cycle method in which we will invoke our GraphQL endpoint.
  • (Line: 5) The 'GetAllCakes' property created by the query 'CakeGqlSchema/GetAllCake.graphql'. The 'ExecuteAsync()' method triggers the GraphQL call.
  • (Line: 6-12) Fetching the response data. Here we can observe 'result.Data.AllCakes' means 'Data' is the parent property, 'AllCakes'(this name depended up on your server GraphQL resolver method name) is child property.



Create Operation:

Let's try to implement the create operation by sending a mutation request to the GraphQL endpoint.

In the 'CakeGqlSchema' folder let's add our mutation file like 'CreateCake.graphql'.
CakeGqlSchema/CreateCake.graphql:
mutation CreateCake($newCake:CakeInput!){
  saveCake(newCake:$newCake) {
    id
  }
}
  • Here 'CreateCake' in normal Graphql mutation we won't add but here we add because strawberry shake library used this name to create method in the 'CakeGql'(Client class generated by strawberry shake).
Note:- Once 'CreateCake.graphql' file is added run the build command so that 'CakeGql' get refreshed with new methods related to the files we created

Now let's create a new blazor component like 'AddOrUpdateCakeDialog.razor' that acts as MudBlazor Dialog component.
Pages/AddOrUpdateCakeDialog.razor:(Html Part)
<MudDialog>
    <DialogContent>
        <MudTextField T="string" Label="Name" @bind-Value="cake.Name" />
        <MudTextField T="decimal" Label="Price" @bind-Value="cake.Price" />
        <MudTextField T="string" Label="Description" @bind-Value="cake.Description" Lines=4/>
    </DialogContent>
    <DialogActions>
        <MudButton OnClick="Cancel">Cancel</MudButton>
        <MudButton Color="Color.Primary" OnClick="Submit">Ok</MudButton>
    </DialogActions>
</MudDialog>
  • Here rendering MudBlazor Dialog components and creating the form where we can submit the form to create a new item.
Pages/AddOrUpdateCakeDialog.razor:(C# Part)
@code {
    [CascadingParameter] MudDialogInstance MudDialog { get; set; }
 
    [Parameter] public CakeDto cake { get; set; } = new CakeDto();
 
    private void Cancel()
    {
        MudDialog.Cancel();
    }
 
    private void Submit()
    {
        MudDialog.Close(DialogResult.Ok<CakeDto>(cake));
    }
}
  • (Line: 2) The 'MudDialogInstance' gives control over the dialog box.
  • (Line: 3) The 'CakeDto' was used for form binding and it was decorated with '[Parameter]' which means the component that invoked Dialog can pass the data to the 'CakeDto' instance.
  • (Line: 6-9) The 'Cancel' method to close the dialog.
  • (Line: 11-14) The 'Submit' method passes the form data to its parent component and then closes the dialog.
Now let's update the 'Index.razor' component as follows.
Pages/Index.razor:(Html Part)
@page "/"
@inject CakeGql _cakeGql;
@inject IDialogService _dialogService;

<MudContainer Class="d-flex justify-center mb-2">
    <MudFab Color="Color.Primary" Icon="@Icons.Material.Filled.Add" Size="Size.Large" IconSize="Size.Large" Label="Add A New
    Cake" Class="ma-2" @onclick="(e => CreateAsync())" />
</MudContainer>
<MudGrid Justify="Justify.Center" class="pr-4 pl-4">
   <!-- Code hidden for display purpose -->
</MudGrid>
  • (Line: 3) Injected the 'IDialogService' instance that helps to interact with MudBlazor Dialog.
  • (Line: 5-8) Rendered the 'Add A New Cake' button and its click registered with the 'CreateAsync()' method.
Pages/Index.razor:(Code Part)
private async Task CreateAsync()
{
	var parameters = new DialogParameters();
	parameters.Add("cake", new CakeDto());
	var dialog = await _dialogService.Show<AddOrUpdateCakeDailog>("Create A Post", parameters).Result;

	if (dialog.Data != null)
	{
		CakeDto newCake = dialog.Data as CakeDto;

		var gqlPayload = new CakeInput()
		{
			Description = newCake.Description,
			Id =0,
			Name = newCake.Name,
			Price = newCake.Price
		};

		var result = await _cakeGql.CreateCake.ExecuteAsync(gqlPayload);
		newCake.Id = result.Data.SaveCake.Id;

		allCakes.Insert(0, newCake);
	}
}
  • (Line: 3) Initialized the 'DialogParameters'.
  • (Line: 4) Adding the 'CakeDto' instance as a parameter.
  • (Line: 5) Using 'IDialogService.Show()' method opens the popup. For the 'Show()' method first parameter is the title of the Dialog, 2nd parameter of the type 'DialogParameters'.
  • (Line: 7) This conditional statement was executed on closing the Dialog. The 'dailog.Data' is empty if we click the 'Cancel' button. The 'dailog.Data' contains form data on clicking the 'Ok' button.
  • (Line: 9-17) Here 'CakeInput' type is autogenerated by the Strawberry Shake. The 'CakeInput' is the GraphQL variable type.
  • (Line: 19) Invoking the Graphql endpoint by sending mutation requests. The 'CreateCake' property gets created based on the Graphql files added in the 'CakeGqlSchema' folder.
  • (Line: 20) Newly created record 'Id'.
  • (Line: 22) Newly created record added to the on top of the existing items collection.




Update Operation:

Let's try to implement the update operation by sending a mutation request to the GraphQL endpoint.

In the 'CakeGqlSchema' folder let's add our mutation file like 'UpdateCake.graphql'.
CakeGqlSchema/UpdateCake.graphql:
mutation ModifyCake($updateCake:CakeInput!){
  updateCake(updateCake:$updateCake) {
    id
  }
}
  • Here 'ModifyCake' name will be used by the 'CakeGql'(client generated by the Strawberry Shake).
Note:- After adding the 'UpdateCake.graphql' file make sure to build the project, so that the 'CakeGql' gets updated with the latest changes.

Now in the 'Index.razor' let's add the update operation logic as follows.
Index.razor:(Html Part)
<MudIconButton Icon="@Icons.Filled.Edit" Color="Color.Primary" @onclick="(e => UpdateAsync(cake.Id))" />
  • Here our 'Edit' button click registered with the 'UpdateAsync()' method.
Index.razor:(C# Part)
private async Task UpdateAsync(int id)
{
	var parameters = new DialogParameters();
	var cakeNeedToUpdate = allCakes.FirstOrDefault(_ => _.Id == id);
	parameters.Add("cake", cakeNeedToUpdate);
	var dialog = await _dialogService.Show<AddOrUpdateCakeDailog>("Update A Item", parameters).Result;
	if (dialog.Data != null)
	{
		var updatedCake = dialog.Data as CakeDto;
		var gqlPayload = new CakeInput()
		{
			Description = updatedCake.Description,
			Id =updatedCake.Id,
			Name = updatedCake.Name,
			Price = updatedCake.Price
		};
		var result = await _cakeGql.ModifyCake.ExecuteAsync(gqlPayload);

		allCakes.Remove(cakeNeedToUpdate);
		allCakes.Insert(0, updatedCake);
	}
}
  • (Line: 4-5) Adding the record to update as the 'DialogParameters' parameter so that data gets populated onto our dialog.
  • (Line: 17) Invokes Graphql endpoint and sends mutation request for the updating the data at the server.




Delete Operation:

Let's try to implement the delete operation by sending a mutation request to the GraphQL endpoint.

In the 'CakeGqlSchema' folder let's add our mutation file like 'DeleteCake.graphql'.
CakeGqlSchema/DeleteCake.graphql:
mutation RemoveCake($id:Int!){
  deleteCake(id:$id)
}
  • Here 'RemoveCake' name will be used by the 'CakeGql'(client generated by the Strawberry Shake).
Note:- After adding the 'UpdateCake.graphql' file make sure to build the project, so that the 'CakeGql' gets updated with the latest changes.

In the 'Index.razor' component let's add the delete operation logic as follows.
Pages/Index.razor:(Html Part)
<MudIconButton Icon="@Icons.Filled.Delete" Color="Color.Error" @onclick="(e => DeleteAsync(cake.Id))" />
  • Here 'Delete' button registered with 'DeleteAsync()' method.
Pages/Index.razor:(C# Part)
private async Task DeleteAsync(int id)
{
	bool? result = await _dialogService.ShowMessageBox(
	"Delete Confirmation",
	"Deleting can not be undone!",
	yesText: "Delete!", cancelText: "Cancel");

	if (result ?? false)
	{
		await _cakeGql.RemoveCake.ExecuteAsync(id);
		var cakeToRemove = allCakes.FirstOrDefault(_ => _.Id == id);
		allCakes.Remove(cakeToRemove);
	}
}
  • (Line: 3-7) Using the 'IDialogService' display a small delete confirmation dialog.
  • (Line: 8) The 'result' value will be 'null' on clicking the 'Cancel' button, the 'result' value will be 'true' on clicking the 'Delete' button.
  • (Line: 10) Invokes the GraphQL endpoint and sends a mutation request for deleting an item.


Support Me!
Buy Me A Coffee PayPal Me

Video Session:

Wrapping Up:

Hopefully, I think this article delivered some useful information on a basic CRUD operation in Blazor WebAssembly with Strawberry Shake Library for consuming GraphQL endpoint. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

  1. Great blog. So thorough. You have mastered Hot Chocolate and Strawberry Shake. Can you please upload the finished working code for this blog to GitHub?

    ReplyDelete
  2. Thank you so much for this post. The docs on Strawberry Shake is sketchy at best, so this is great!

    ReplyDelete
  3. i migrated my project to .net7 and strawberryshake 13, and it seem the mutation aint calling the api side. the queries and the signalR is working fine though

    ReplyDelete

Post a Comment

Popular posts from this blog

Angular 14 Reactive Forms Example

In this article, we will explore the Angular(14) reactive forms with an example. Reactive Forms: Angular reactive forms support model-driven techniques to handle the form's input values. The reactive forms state is immutable, any form filed change creates a new state for the form. Reactive forms are built around observable streams, where form inputs and values are provided as streams of input values, which can be accessed synchronously. Some key notations that involve in reactive forms are like: FormControl - each input element in the form is 'FormControl'. The 'FormControl' tracks the value and validation status of form fields. FormGroup - Track the value and validate the state of the group of 'FormControl'. FormBuilder - Angular service which can be used to create the 'FormGroup' or FormControl instance quickly. Form Array - That can hold infinite form control, this helps to create dynamic forms. Create An Angular(14) Application: Let'

.NET 7 Web API CRUD Using Entity Framework Core

In this article, we are going to implement a sample .NET 7 Web API CRUD using the Entity Framework Core. Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, and desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains programming functions that can be requested via HTTP calls either to fetch or update 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 the REST full services. Install The SQL Server And SQL Management Studio: Let's install the SQL server on our l

ReactJS(v18) JWT Authentication Using HTTP Only Cookie

In this article, we will implement the ReactJS application authentication using the HTTP-only cookie. HTTP Only Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing the 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 the authentication with HTTP-only JWT cookie then we no need to implement the 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 authenticate our client application with JWT HTTP-only cookie, I developed a NetJS(which is a node) Mock API. Check the GitHub link and read the document on G

.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

Angular 14 State Management CRUD Example With NgRx(14)

In this article, we are going to implement the Angular(14) state management CRUD example with NgRx(14) NgRx Store For State Management: In an angular application to share consistent data between multiple components, we use NgRx state management. Using NgRx state helps to avoid unwanted API calls, easy to maintain consistent data, etc. The main building blocks for the NgRx store are: Actions - NgRx actions represents event to trigger the reducers to save the data into the stores. Reducer - Reducer's pure function, which is used to create a new state on data change. Store - The store is the model or entity that holds the data. Selector - Selector to fetch the slices of data from the store to angular components. Effects - Effects deals with external network calls like API. The effect gets executed based the action performed Ngrx State Management flow: The angular component needs data for binding.  So angular component calls an action that is responsible for invoking the API call.  Aft

Angular 14 Crud Example

In this article, we will implement CRUD operation in the Angular 14 application. Angular: Angular is a framework that can be used to build a single-page application. Angular applications are built with components that make our code simple and clean. Angular components compose of 3 files like TypeScript File(*.ts), Html File(*.html), CSS File(*.cs) Components typescript file and HTML file support 2-way binding which means data flow is bi-directional Component typescript file listens for all HTML events from the HTML file. Create Angular(14) Application: Let's create an Angular(14) application to begin our sample. Make sure to install the Angular CLI tool into our local machine because it provides easy CLI commands to play with the angular application. Command To Install Angular CLI npm install -g @angular/cli Run the below command to create the angular application. Command To Create Angular Application ng new name_of_your_app Note: While creating the app, you will see a noti

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

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

ReactJS(v18) Authentication With JWT AccessToken And Refresh Token

In this article, we are going to do ReactJS(v18) application authentication using the JWT Access Token and Refresh Token. JSON Web Token(JWT): JSON Web Token is a digitally signed and secured token for user validation. The JWT is constructed with 3 important parts: Header Payload Signature Create ReactJS Application: Let's create a ReactJS application to accomplish our demo. npx create-react-app name-of-your-app Configure React Bootstrap Library: Let's install the React Bootstrap library npm install react-bootstrap bootstrap Now add the bootstrap CSS reference in 'index.js'. src/index.js: import 'bootstrap/dist/css/bootstrap.min.css' Create A React Component 'Layout': Let's add a React component like 'Layout' in 'components/shared' folders(new folders). src/components/shared/Layout.js: import Navbar from "react-bootstrap/Navbar"; import { Container } from "react-bootstrap"; import Nav from "react-boot

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