Skip to main content

Different HttpClient Techniques To Consume API Call's In Blazor WebAssembly

 

In .Net Core applications, HttpClient instance should be managed by HttpClienFactory with the support of Dependency Injection(DI). Blazor Assembly applications also have those capabilities to use the 
HttpClient object in an efficient manner. The techniques provided by the .Net  framework are:
  1. Register HttpClient Object Explicitly In DI(Dependency Injection Service)
  2. Named Client
  3. Type Client
  4. HttpRequestMessage Object
In this article, we are going to implement Get API call with the above techniques mentioned using a sample Blazor WebAssembly application.

Create Blazor WebAssembly Sample App:

To follow up on the steps let's begin by creating a sample Blazor WebAssembly application. Use any of the editors of your choice most recommended are like VisualStudio 2019(Support .Net 3.0 plus) or Visual Studio Code.

Third-Party Rest API:

To show sample implementation of the Blazor WebAssembly application here I'm going to use external free Rest API for our demos - "https://jsonplaceholder.typicode.com/todos"

Register HttpClient Object Explicity In DI(Technique - 1):

Initialize HttpClient object with a configuration like 'domain', 'default headers', etc in the Dependency Injection services. After that, we can inject the HttpClient object on *.razor(any Blazor Component), this injects implicitly done in the context of the HttpClientFactory. The only negative impact of the approach is when we have multiple different domain APIs to consume this approach fails to work. Because the last HttpClient object registration will override all other HttpClient registration. So this technique good when our application uses single domain API endpoints.

On creating our sample Blazor WebAssembly application we will get some startup boiler code with few pages. In those pages, in 'fetchdata' page this HttpClient approach is used by default. Let's explore it now.
Program.cs:
builder.Services.AddScoped(sp => new HttpClient { BaseAddress = new Uri(builder.HostEnvironment.BaseAddress) });
The HttpClient object registered in DI service as 'AddScoped'(object lives for entire user request). Registered our localhost URL(This technique code is by default generated code so I'm not replacing any of the code in this technique for remaining techniques I will use external 'todos' rest endpoint).
Pages/FetchData.razor:(Blazor Page Component)
@page "/fetchdata"
@inject HttpClient Http
<!-- some code hidden for display purpose -->
@code {
   
    protected override async Task OnInitializedAsync()
    {
        forecasts = await Http.GetFromJsonAsync<WeatherForecast[]>("sample-data/weather.json");
    }
}
  • (Line: 1) '@page' directive to declare the route for the page
  • (Line: 2)'@inject' directive to inject our class in razor files, here we injecting HttpClient object, typically implicitly done by IHttpClientFacotry.
  • (Line: 6-8) 'OnInitializedAsync' Blazor WebAssembly life cycle method to prefetch some data at the time of the application loading. 'GetFromJsonAsync' method to invoke a get method by taking endpoint as a URL. The 'GetFromJsonAsync' extension method comes with a new library 'System.Net.Http.JSon' which by default installed from .Net Core 3.2.
Now run the application navigate to route "/fetchdata"

Now let's try to register one more HttpClient object with 'todos' endpoint domain to it and check the behavior of it.
Program.cs:
builder.Services.AddScoped(sp => new HttpClient { BaseAddress = new Uri(builder.HostEnvironment.BaseAddress) });
builder.Services.AddScoped(sp => new HttpClient { BaseAddress = new Uri("https://jsonplaceholder.typicode.com/") });
By doing this last registered HttpClient will override all others(implemented with the same technique) above it. Now run the application and confirm the override scenario as below.

Named Client:(Technique - 2)

The HttpClient object will be generated or invoked with the 'names'. So while registering the client we have to specify the 'name' for the HttpClient. Utilizing the same 'name' have to be used to create an HttpClient object. This approach supports multiple HttpClient registrations with their respective names.
Program.cs:
builder.Services.AddHttpClient("JsonPlaceHolderClient",client => {
	client.BaseAddress = new Uri("https://jsonplaceholder.typicode.com/");
});

  • The 'JsonPlaceHolderClient' is the name for our HttpClient object.
To bind the response data from the 'todo' endpoint let's create 'Todo' model for API response data serialization.
Models/Todos.cs:
namespace BzWassem.ClientTypes.Models
{
    public class Todos
    {
        public int UserId { get; set; }
        public int Id { get; set; }
        public string Title { get; set; }
        public bool Completed { get; set; }
    }
}
Now let's create a Blazor page to implement the 'Named' HttpClient object as follow.
Pages/NamedClient.razor:
@page "/named-client"
@using BzWassem.ClientTypes.Models;
@inject IHttpClientFactory _clientFacotry;
<h3>NamedClient</h3>
<div>
    @foreach (var todo in todos)
    {
        <p>@todo.Title</p>

    }
</div>

@code {
    private List<Todos> todos = new List<Todos>();

    protected override async Task OnInitializedAsync()
    {
        var httpClient = _clientFacotry.CreateClient("JsonPlaceHolderClient");
        todos = await httpClient.GetFromJsonAsync<List<Todos>>("/todos");
    }
}
  • (Line: 3) Injected IHttpClientFactory on the Blazor page
  • (Line: 18) creating a HttpClient object from IHttpClientFactory using the client registered name(eg: JsonPlaceHolderClient).

Typed Client:(Technique - 3)

Each external API domain will have a separate class to inject the HttpClient object. This class will be registered as the type in DI services.
Clients/JsonPlaceHolderClient.cs:
using BzWassem.ClientTypes.Models;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Json;
using System.Threading.Tasks;

namespace BzWassem.ClientTypes.Clients
{
    public class JsonPlaceHolderClient
    {
        private HttpClient _httpClient;
        public JsonPlaceHolderClient(HttpClient httpClient)
        {
            _httpClient = httpClient;
        }

        public async Task<List<Todos>> GetTodos()
        {
            return await _httpClient.GetFromJsonAsync<List<Todos>>("/todos");
        }
    }
}
  • The HttpClient object injected into the 'JsonPlaceHolderClient' file, this file act as a type for registration in DI.
Program.cs:
builder.Services.AddHttpClient<JsonPlaceHolderClient>(client =>
{
	client.BaseAddress = new Uri("https://jsonplaceholder.typicode.com/");
});
  • Registered HttpClient with its type as 'JsonPlaceHolderClient', this makes 'JsonPlaceHolderClient' as injectable instance.
Let's create a Blazor page that consumes this Typed Client as follows.
Pages/TypeClient.razor:
@page "/typed-client"
@using BzWassem.ClientTypes.Clients
@using BzWassem.ClientTypes.Models
@inject JsonPlaceHolderClient _jsonPlaceHolderClient;
<h3>TypedClient</h3>
<div>
    @foreach (var todo in todos)
    {
        <p>@todo.Title</p>
    }
</div>

@code {
    protected List<Todos> todos = new List<Todos>();

    protected override async Task OnInitializedAsync()
    {
        todos = await _jsonPlaceHolderClient.GetTodos();
    }
}
  • (Line: 4) Injected the Typed Client into the Blazor page.

HttpRequestMessage Object:(Technique - 4)

In this approach HttpRequestMessage object will be used to configure settings like 'domain', 'headers','payload', etc, this object will be used by the HttpClient object to invoke or consume the rest API.
Program.cs:
builder.Services.AddHttpClient();
  • Simple registration of HttpClient this makes IHttpClientFactory can be injectable service.

Pages/RequestMessageType.razor:

@page "/request-message"
@using BzWassem.ClientTypes.Models
@inject IHttpClientFactory _httpClientFicatory;
<h3>RequestMessageType</h3>
<div>
    @foreach (var todo in todos)
    {
        <p>@todo.Title</p>
    }
</div>

@code {

    private List<Todos> todos = new List<Todos>();

    protected override async Task OnInitializedAsync()
    {
        var request = new HttpRequestMessage(HttpMethod.Get, "https://jsonplaceholder.typicode.com/todos");
        var httpClient = _httpClientFicatory.CreateClient();
        var response = await httpClient.SendAsync(request);
        todos = await response.Content.ReadFromJsonAsync<List<Todos>>();
    }
}
  • (Line: 3) IHttpClientFactory injected into the Blazor page
  • (Line: 18) Initialized HttpRequestMessage object with action type and endpoint as the input parameters.
  • (Line: 19)Using IHttpClienFactory creating the instance of the HttpClient
  • (Line: 10)HttpRequestMessage is used as input parameter to the HttpClient object 'SendAsync' method.

Wrapping Up:

Hopefully, I think this article delivered some useful information on Blazor WebAssembly to call API endpoints using different techniques with HttpClient. I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

Popular posts from this blog

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", defaults:new { …

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.Types likely to be called Grap…

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 VersioningUrl Path VersioningMedia 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.AspNetCore.Mvc.Versioning -version 4.0.0 Register API V…

.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 from the client, then the entire …

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: PickerControllerPickerOptions 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", "Lion", "Elephant"…

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 below.
PersonController.cs: us…

Blazor WebAssembly Dynamic Form Validation

Introduction: In Blazor WebAssembly(client-side framework) form validation can be done with Data Annotations. Using Data Annotations we can validate form either by default validation attributes or by creating custom validation attributes. Using this Data Annotation attribute we can dynamically add or remove validation on a specific field in a form.
Create Blazor WebAssembly Project: To create a Blazor WebAssembly template project need to install the latest version of VisualStudio 2019 for rich intelligence support or we can use VisualStudio code but less intelligence support from the editor. Click here to know about Blazor WebAssembly template creation. Blazor WebAssembly is in preview mode, not yet ready for production.
Create Razor Component: After creating a sample project using the Blazor WebAssembly template, in "Pages" folder add new Razor Component, name it as "UserForm.razor"
Add Route: In Blazor routing can be configured using @page  directive, and URL should b…

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 information or changed …

NestJS API CRUD Operations With MongoDB

Introduction: NestJS is a framework used to develop server-side applications. NestJS built on top of Node.js frameworks like Express. It is a combination of Progressive Javascript, Object-Oriented Programming, Functional Programming, and Functional Reactive Programming.
Nest CLI Installation: Using Nest CLI we are able to generate the NestJS starter project with the default template. To install Nest CLI globally over our system open command prompt and run the command
npm i -g @nestjs/cli Now create a sample project by using Nest CLI command  nest new your_project_name package.json: Now open the package.json file from the sample application created, you can observe few properties like "scripts", "dependencies", and "devDependencies".
"dependencies" contains all plugins to be installed and used them to run the application.
"devDependencies" contain all plugins to be installed and used them at the time of application development.
"scrip…

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-ControlPragmaVary 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 fresh response from serverno-store…