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

Popular posts from this blog

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

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

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

GraphQL API Integration In Asp.Net Core Application

Introduction: GraphQL 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 ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data. How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions. HTTP-POST is the only Http verb recommended by the GraphQL. The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API: The main building blocks of GraphQL API is Schemas and Types.  A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc. T

ASP.NET Core Web API Versioning

Introduction: An iteration and evolutionary changes of an ASP.NET Core Web API is handled by Versioning. Versioning of an API gives confidence to the clients which consumes API for a long time. Any changes or development of an API will be accessible using the new version and it won't cause issues to the clients consuming the old version of API. When To Use Versioning: Any API response changes. Developing an API by implementing testing levels like 'Alpha', 'Beta', and 'RC' versions before releasing Production. Deprecating an API which means API going to be removed or upgraded by a version within a short period. Versioning Types: Query String Versioning Url Path Versioning Media Type Versioning API Version Nuget: To Configure versioning to AspNet Core Web API Microsoft provided a library(Microsoft.AspNetCore.Mvc.Versioning). So to use the versioning library please install NuGet below.              Install-Package Microsoft.A

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http

Blazor Server CRUD Operations

Introduction: Blazor Server is a web framework to develop server-side single-page applications. Blazor is made up of components with the combinations on C#, Html, CSS.  Blazor Server is production-ready from the .Net Core 3.0.  Blazor Server Working Mechanism: Blazor Server is a very light-weight web development framework.  In Blazor Server, not all code gets downloaded to the client browsers. Blazor Server made of components these components can be a block of code or page with respective navigation.  Blazor server application communicates with the server with a SignalR background connection which is inbuilt functionality. Application click,  form submission, change events, application page navigation every operation is carried out by the SignalR connection by communicating with the server.  Blazor updates the Html DOM very gently on every data update without any overhead. Blazor Server application maintains a nice intelligent tree structure to update the required inform