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:

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

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

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

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

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

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

Different HttpClient Techniques To Consume API Calls In Minimal API[.NET6]

In this article, we are going to implement different HttpClient techniques to consume API calls in minimal API. The different HttpClient techniques that we are going to explore are like: Register HttpClient Object Explicitly In DI(Dependency Injection Service) Named Client Type Client HttpRequestMessage Object Create A .NET6 Minimal API Project: Let's create a .Net6 Minimal API sample project 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. CLI command For Minimal API Project dotnet new webapi -minimal -o Your_Project_Name Create A Third Party API Response Model: Here I'm going to use a free third-party rest API that is "https://jsonplaceholder.typicode.com/posts". So to receive the response let's create a response model like 'Post.cs'. Program.cs:(Add Post.cs c

.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