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).
public class TodoItem
	public int id { get; set; }
	public string itemNames { get; set; }
Now let's add Typed Client.
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");
            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.
public void ConfigureServices(IServiceCollection services)
Let's add test controller which calls API in Typed Client.
using System.Threading.Tasks;
using httpjson.sample.api.Clients;
using Microsoft.AspNetCore.Mvc;

namespace httpjson.sample.api.Controllers
    public class TestController : ControllerBase
        private readonly TodoClient _todoClient;
        public TestController(TodoClient todoClient)
            _todoClient = todoClient;

        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.
public async Task<List<TodoItem>> GetTodos()
	var response = await _httpClient.GetAsync("/api/todo/get-all");
	// 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.
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.
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);
#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.
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.

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.


Follow Me:


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


Post a Comment

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

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.

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 - this directive represents no storing of response and always fetch the fresh response from serverno-store…