Skip to main content

.Net5 Blazor WebAssembly Application Invoke GraphQL Endpoints Using Strawberry Shake Library

In this article, we will implement a Blazor WebAssembly Application that consumes GraphQL endpoints using the Strawberry Shake library.

Strawberry Shake:

Strawberry Shake is a GraphQL client library that can be used by the .Net Standard Library. So all .NetCore applications (from .Net5) like APIs, MVC, Blazor Server, Blazor WebAssembly, etc.

Strawberry Shake will generate all boilerplate code for the GraphQL Server schema, which lays an easy path for consuming the data from our Blazor WebAssembly application.

Strawberry Shake CLI Tool Configuration:

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

Create a dotnet tool-manifest
dotnet new tool-manifest
Now install the Strawberry Shake CLI Tool 
dotnet tool install StrawberryShake.Tools --local

Create A .Net5 Blazor WebAssembly Project:

Let's start our journey by creating a .Net5 Blazor WebAssembly application sample project.

Visual Studio users can easily create .Net5 Blazor WebAssembly application. On creating an application, visual studio UI shows different application template options in that we have to select 'Blazor WebAssembly App'.

Here for this demo, I'm going to use Visual Studio Code editor and .NET CLI commands. Run the below .NET CLI command to create Blazor WebAssembly App.
CLI Command To Blazor WebAssembly Application:
dotnet new blazorwasm -n your_project_name

Install Required NuGet Packages:

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

.NET CLI Command
dotnet add package StrawberryShake.Transport.Http --version 11.3.0
Add the 'StrawberryShake.CodeGeneration.CSharp.Analyzers' NuGet. 
Package Manager Command:
Install-Package StrawberryShake.CodeGeneration.CSharp.Analyzers -Version 11.3.0

.NET CLI Command
dotnet add package StrawberryShake.CodeGeneration.CSharp.Analyzers --version 11.3.0
Add the 'Microsoft.Extensions.DependencyInjection' NuGet. 
Package Manager Command:
Install-Package Microsoft.Extensions.DependencyInjection -Version 5.0.1

.NET CLI Command
dotnet add package Microsoft.Extensions.DependencyInjection --version 5.0.1
Add the 'Microsoft.Extensions.Http' NuGet. 
Package Manager Command:
Install-Package Microsoft.Extensions.Http -Version 5.0.0

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

GraphQL Server Endpoint:

I had created a HotChocolate GraphQL Server endpoint in my local system that I'm going to consume into our Blazor Web Application. Click Here For An Overview On Hot Chocolate GraphQL Implementation In Pure Code First Approach.

In our Blazor WebAssembly sample, we try to consume the following 3 GraphQL commands:

1. GraphQL Query to fetch collection or records.

2. Graphql Query with filter values.

3. GraphQL Mutation to save the new record.

Generate GraphQL Client Using GrpahQL Server Schema:

Strawberry Shake helps to generate a lot of boilerplate code like 'Schema'(Generates Server GraphqQL Schema into our blazor application ), 'GrpahQL Client' (this client class generated on based the schema, this client class contains all HTTP calls with predefined methods).

Run the following Strawberry Shake CLI Tool command.
dotnet graphql init https://YourDomain/graphql/ -n YourClientName -p ./YourFolderName
'YourClientName' - Specify any name this will be used to generate Client Class that will contain predefined methods to invoke the Grapqhl calls.

'YourFolderName' - Specify any name, a folder will be created that contains files like below.

In '.graphqlrc.json', we have to add a new property like 'namespace' this namespace will be used by 'Client class'(will be generated once we build our project).

Now let's create a GraphQL query to fetch all records(Picture1 in GraphQL Server Endpoint section).
So to add the GrapqhQL query in a separate file, so let's create a file like 'GetAllGadget.graphql'.
MyGqlServer/GetAllGadget.graphql:
  query GetAllGadget{
  fetchAllGadgets{
    id,
    productName,
    brand,
  }
}
  • Here 'GaetAllGadget' name is optional for a GraphQL query, but on using Strawberry Shake we must define the name because this name will be used in the 'GrpahQL Client Class'.
Now build the project, so that the GraphQL Client class will be generated as below.

In the above steps in '.graphqlrc.json' added namespace, so the same namespace now imported into the '_Import.razor' file.
_Import.razor:
@using Dot5.Bwasm.StraberryShake.Sample.MyGqlServer
Now configure our newly generated GraphQL client class in 'Startup.cs'.
Startup.cs:
builder.Services.AddMyGqlServerClient()
.ConfigureHttpClient(client =< client.BaseAddress = new Uri("https://localhost:6001/graphql/"));

Invoke GraphQL Query Endpoint To Fetch Collection Of Records:

Now we will invoke the GrqphQL query endpoint to fetch the collection of records(refer to Picture1 in the GraphQL Endpoint Server section).

Now let's create a model for the GraphQL endpoint response.
Models/Gadgets.cs:
namespace Dot5.Bwasm.StraberryShake.Sample.Models
{
    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; }
    }
}
Now register the Model folder namespace in '_Import.razor'.
_Import.razor:
@using Dot5.Bwasm.StraberryShake.Sample.Models
So let's change the content in 'Index.razor'(Blazor Component).
Pages/Index.razor:(HTML Part)
@page "/"
@inject MyGqlServerClient _myGqlServerClient;
<div>
    <table class="table table-bordered">
        <thead>
            <tr>
                <th scope="col">Id</th>
                <th scope="col">Product Name</th>
                <th scope="col">Brand</th>
                <th scope="col">Cost</th>
                <th scope="col">Type</th>
            </tr>
        </thead>
        <tbody>
            @foreach (var item in AllGadgets)
            {
                <tr>
                    <th scope="row">@item.Id</th>
                    <td>@item.ProductName</td>
                    <td>@item.Brand</td>
                    <td>@item.Cost</td>
                    <td>@item.Type</td>
                </tr>
            }
        </tbody>
    </table>
</div>
  • (Line: 2)Injected 'MyGqlServerClient'(Strawberry Shake CLI Tool generated file) GraphL Client.
  • (Line: 16-24) Binding the response data to the bootstrap table.
Pages/Index.razor:(Code Part)
@code
{
    public List<Gadgets> AllGadgets = new List<Gadgets>();
    protected override async Task OnInitializedAsync()
    {
        var results  =  await _myGqlServerClient.GetAllGadget.ExecuteAsync();
        AllGadgets = results.Data.
        FetchAllGadgets.Select(_ => new Gadgets{
            Brand = _.Brand,
            Cost = _.Cost,
            Type = _.Type,
            Id = _.Id,
            ProductName = _.ProductName
        }).ToList();
    }
}
  • (Line: 3) Initialized 'AllGadgets' property of 'Gadgets' type collection.
  • (Line: 4) The 'OnInitializedAsync' is the life cycle method of the Blazor application.
  • (Line: 6) Using '_myGqlServerClient'(GraphQL Client entity) invoking the GraphQL call.
  • (Line: 7-14) Fetching data from the API response.

Consume GraphQL EndPoint With Filter Values:

Let's understand the steps to invoke the GraphQL endpoint with the filter values from our Blazor WebAssembly application.

So first let's add a new file in the folder 'MyGqlServer' like 'GetFilterByBrand.graphql'. So inside of new file add the below GraphQL command.
MyGqlServer/GetFilterByBrand.graphql:
query GetFilterByBrand($brandQuery:String){
  filterByBrand(brand:$brandQuery){
    id,
    productName,
    cost,
    type,
    brand
  }
}
  • Here 'GetFilterByBrand' name will be generated as a property in our GraphQL client class.
Now let's update our 'Index.razor'(Blazor Component) with search functionality.
Pages/Index.razor:(HTML Part)
@page "/"
@inject MyGqlServerClient _myGqlServerClient;

<div class="container">
    <div class="input-group mb-3">
        <input type="text" @bind="SearchByBrand" class="form-control" placeholder="Search By Brand">
        <button class="btn btn-outline-primary" @onclick="OnSearch" type="button" id="button-addon2">Search</button>
    </div>
</div>
<!-- Code hidden for display purpose -->
  • (Line: 6) Input filed decorated with '@bind' directive which enables 2-way binding. Here '@bind' uses the 'SearchByBrand' variable.
  • (Line: 7) Button registered with a click event that triggers the 'OnSearch' method.
Pages/Index.razor:(Code Part) 
@code
{
    public string SearchByBrand = string.Empty;
    
    public async Task OnSearch()
    {
        if (!string.IsNullOrEmpty(SearchByBrand))
        {
            var results = await _myGqlServerClient.GetFilterByBrand.ExecuteAsync(SearchByBrand);
            AllGadgets = results.Data.
            FilterByBrand.Select(_ => new Gadgets
            {
                Brand = _.Brand,
                Cost = _.Cost,
                Type = _.Type,
                Id = _.Id,
                ProductName = _.ProductName
            }).ToList();
        }
    }
}
  • (Line: 3) Initialized a 'SearchByBrand' variable. This variable captures the value entered in the search box.
  • (Line: 9) Using the '_myGqlServerClient' invokes the GraphQL endpoint with filter data as input data.
  • (Line: 10-18) Fetching the data from the GraphQL response.

Invoke GraphQL Mutation Endpoint To Save A Record:

Now we will implement logic to invoke the GraphQL mutation endpoint in our Blazor WebAssembly application.

In the 'MyGqlServer' folder let's add a new file 'AddGadget.graphql'. So in 'AddGadget.graphql' add our Mutation command. Nex after adding the mutation command build the project so that the GraphQL client will be updated with a new mutation method.
MyGqlServer/AddGadget.graphql:
mutation AddGadget($myGadgets:GadgetsInput){
  save(model: $myGadgets){
    id,
    productName,
    brand,
    cost,
    type
  }
}
Now add a HTML form in our 'Index.razor'.
Pages/Index.razor:(HTML Part)
@page "/"
@inject MyGqlServerClient _myGqlServerClient;
<div class="container">
    <h3>Add Gadget</h3>
    <div>
        <div class="mb-3">
            <label for="txtProductName" class="form-label">Product Name</label>
            <input @bind="FormPayload.ProductName" type="text" class="form-control" id="txtProductName">
        </div>
        <div class="mb-3">
            <label for="txtBrand" class="form-label">Brand</label>
            <input @bind="FormPayload.Brand" type="text" class="form-control" id="txtBrand">
        </div>
        <div class="mb-3">
            <label for="txtCost" class="form-label">Cost</label>
            <input @bind="FormPayload.Cost" type="text" class="form-control" id="txtCost">
        </div>
        <div class="mb-3">
            <label for="txtType" class="form-label">Type</label>
            <input @bind="FormPayload.Type" type="text" class="form-control" id="txtType">
        </div>
        <div>
            <button class="btn btn-dark" @onclick="Add" type="button" id="button-addon2">Add</button>
        </div>
    </div>
</div>
< !-- code hidden for display purpose -->
  • Here added input fields for creating a new record. Each input field decorated with the '@bind' directive to establish a 2-way binding.
  • (Line: 23) Button registered with the 'Add' method for the click event.
Pages/Index.razor:(Code Part) 
@code
{
    // code hidden for display purpose
    public GadgetsInput FormPayload = new GadgetsInput();
    public async Task Add()
    {

        var result = await _myGqlServerClient.AddGadget.ExecuteAsync(FormPayload);
        var gadget = new Gadgets
        {
            Id = result.Data.Save.Id,
            Cost = result.Data.Save.Cost,
            Brand =  result.Data.Save.Brand,
            ProductName = result.Data.Save.ProductName,
            Type = result.Data.Save.Type
        };
        AllGadgets.Insert(0, gadget);
    }
}
  • (Line: 4) Initialized 'FormPayload' variable. The 'GadgetsInput' type is auto-generated by the Strawberry Shake CLI based on the GraphQL 'Mutation' command.
  • (Line: 8) Invoking GraphQL mutation endpoint.
  • (Line: 9-17) Inserted newly added record into the 'AllGadgets' property.
So that's all about consuming GraphQL endpoint into Blazor WebAssembly application using Strawberry Shake library.

Video Session:

 

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on consuming GraphQL endpoint into Blazor WebAssembly application using Strawberry Shake library. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Labels:

Comments

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'
3 comments
Read more

.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
3 comments
Read more

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
3 comments
Read more

.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
6 comments
Read more

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
8 comments
Read more

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
5 comments
Read more

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
7 comments
Read more

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
Post a Comment
Read more

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
Post a Comment
Read more

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
8 comments
Read more