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.
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'.
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.MyGqlServerNow 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.ModelsSo 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.
@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.
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.
@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.
@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.
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.
thank you very helpful for beginner
ReplyDelete