Skip to main content

.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 HttpClientFactory approach, we can write HttpClient calls in different methods, where Typed Client is one such method. In the Typed Client approach, one class will be defined for one type of external domain, where we will implement all GET or POST calls for that domain in that specified class. So in this sample, I'm using Typed Client.

Let's consume any Web API into our newly created sample application. To explain this example I have created a sample Web API project which returns Todo Items(so to follow my steps please create one sample API project which returns some data, because I'm not explaining here about my Todo endpoint).

Let's start with creating a response object model(ex:- TodoItem).
Models/TodoItem.cs:
public class TodoItem
{
	public int id { get; set; }
	public string itemNames { get; set; }
}
Now let's add Typed Client.
Clients/TodoClient:
using System.Net.Http;
using System;
using System.Threading.Tasks;
using System.Collections.Generic;
using httpjson.sample.api.Models;
using System.Text.Json;
namespace httpjson.sample.api.Clients
{
    public class TodoClient
    {
        private readonly HttpClient _httpClient;
        public TodoClient(HttpClient httpClient)
        {
            httpClient.BaseAddress = new Uri("https://localhost:44379/");
            _httpClient = httpClient;
        }

        public async Task<List<TodoItem>> GetTodos()
        {
            var response = await _httpClient.GetAsync("/api/todo/get-all");
            response.EnsureSuccessStatusCode();
            string data = await response.Content.ReadAsStringAsync();
            return JsonSerializer.Deserialize<List<TodoItem>>(data);
        }
    }
}
  • #L12 at this line HttpClient is injected by HttpClientFactory.
  • #L13 at this line defining base address, nothing but a domain. So all API call implementation in this Typed Client class belongs to that domain(localhost:44379 my custom API I'm consuming in this sample, please create your own endpoint to follow my steps).
  • #L18-L24 these lines define get API call.
  • #L22 at this line response is reading as a string
  • #L23 at this line response is deserialized to object.
Now register our Type Client in Startup.cs as below.
Startup.cs:
public void ConfigureServices(IServiceCollection services)
{
	services.AddControllers();
	services.AddHttpClient<TodoClient>();
}
Let's add test controller which calls API in Typed Client.
Controllers/TestController.cs:
using System.Threading.Tasks;
using httpjson.sample.api.Clients;
using Microsoft.AspNetCore.Mvc;

namespace httpjson.sample.api.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class TestController : ControllerBase
    {
        private readonly TodoClient _todoClient;
        public TestController(TodoClient todoClient)
        {
            _todoClient = todoClient;
        }

        [HttpGet]
        [Route("get-all-todo")]
        public async Task<IActionResult> GetTodos()
        { 
            return Ok(await _todoClient.GetTodosWithJsonExtension());
        }
    }
}
Now run the application and test the API.
Finally, successfully we have created API which consumes other API, everything till now we did is a common approach. In upcoming steps, we going to use JSON extension methods and refactor the above code using them.

Install System.Net.Http.Json Package:

System.Net.Http.Json not bundled with .Net Core Framework needs to install an external package.
Package Manager

Install-Package System.Net.Http.Json
.Net CLI

dotnet add package System.Net.Http.Json

Use ReadFromJsonAsync Extension Method:

ReadFromJsonAsync is an extension method on HttpResponseMessage.Content. Using this method we can avoid explicitly reading the response as string or stream. It also avoids explicit deserialization of response to the output object.

Let's update the code in Typed Client to use the ReadFromJsonAsync method.
Clients/TodoClient.cs:
public async Task<List<TodoItem>> GetTodos()
{
	var response = await _httpClient.GetAsync("/api/todo/get-all");
	response.EnsureSuccessStatusCode();
	// string data = await response.Content.ReadAsStringAsync();
	// return JsonSerializer.Deserialize<List<TodoItem>>(data);
	return await response.Content.ReadFromJsonAsync<List<TodoItem>>();
}
#L7 at this line ReadFromJsonAsync reads the response from content and convert to the output object.
#L5-L6 at this line commented code of old implementation.

Use GetFromJsonAsync Extension Method:

GetFromJsonAsync is an extension method on HttpClient. Using this method it will avoid all traditional functionality like invoking API, reading response, and converting response type to the output object. It is a single line code.

Let's update the code int Typed Client to use the GetFromJsonAsync method.
Clients/TodoClient.cs:
public async Task<List<TodoItem>> GetTodos()
{
	return await _httpClient.GetFromJsonAsync<List<TodoItem>>("/api/todo/get-all");
	//var response = await _httpClient.GetFromJsonAsync("/api/todo/get-all");
	// response.EnsureSuccessStatusCode();
	// string data = await response.Content.ReadAsStringAsync();
	// return JsonSerializer.Deserialize<List<TodoItem>>(data);
}
#L3 at this line GetFromJsonAsync methods invokes API call, reads the response, and then converts the response to the output object type.
#L4-L7 at this line commented old implementation code.

HttpClient Post:

Let's write a sample code for the post method for HttpClient.
Clients/TodoClients.cs:
public async Task PostTodo(TodoItem todo)
{
	var postData = new StringContent(JsonSerializer.Serialize(todo),Encoding.UTF8,"application/json");
	var response = await _httpClient.PostAsync("/api/todo/save",postData);
	response.EnsureSuccessStatusCode();
}
#L3 at this line we can observe post object serialized before sending to API call.

Use PostAsJsonAsync Extension Method:

PostAsJsonAsync is an extension method on  HttpClient. This method will automatically serialize post data and invoke API calls. It is a single line code.

Let's update the HttpClient post method to use the PostAsJsonAsync extension method.
Clients/TodoClient.cs:
public async Task PostTodo(TodoItem todo)
{
	await _httpClient.PostAsJsonAsync("/api/todo/save",todo);
	// var postData = new StringContent(JsonSerializer.Serialize(todo),Encoding.UTF8,"application/json");
	// var response = await _httpClient.PostAsync("/api/todo/save",postData);
	// response.EnsureSuccessStatusCode();
}
#L3 at this line PostAsJsonAsync used for sending a serialized payload to the API endpoint.
#L4-L6 at these lines old implementation code commented.

Support Me!
Buy Me A Coffee PayPal Me 

Wrapping Up:

Hopefully, I think this article delivered some useful information about System.Net.Http.Json package of extension methods used for Httpclient. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Comments

  1. This is something we need to do all the time, but I was not aware of this package. Thanks for sharing!

    ReplyDelete

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

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

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

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

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

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

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'

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

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