https://github.com/kralizek/httpextensions
Classes and extension methods to make easier to work with REST APIs via HttpClient
https://github.com/kralizek/httpextensions
dotnet-standard http-client querystring rest-client
Last synced: 6 months ago
JSON representation
Classes and extension methods to make easier to work with REST APIs via HttpClient
- Host: GitHub
- URL: https://github.com/kralizek/httpextensions
- Owner: Kralizek
- License: mit
- Created: 2018-01-27T19:13:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T20:37:52.000Z (over 2 years ago)
- Last Synced: 2024-11-08T04:49:59.297Z (6 months ago)
- Topics: dotnet-standard, http-client, querystring, rest-client
- Language: C#
- Size: 63.5 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kralizek's HTTP Extensions
## Overview
This repository contains a set of extensions to ease working with HTTP requests and response in .NET.
### Kralizek.Extensions.Http
This package offers basic HTTP utilities.
#### Query string
The `HttpQueryStringBuilder` class helps creating a valid query string using the same methodology of the `StringBuilder`.
```csharp
var builder = new HttpQueryStringBuilder();
builder.Add("foo", "bar");
builder.Add("hello", "world");
builder.Add("asd", "lol");
string query = builder.BuildQuery();
Console.WriteLine(query); // asd=lol&foo=bar&hello=world
```
The `BuildQuery` method offers the possibility of collating items with the same key with a separator.
```csharp
var builder = new HttpQueryStringBuilder();
builder.Add("fields", "firstName");
builder.Add("fields", "lastName");
var query = builder.BuildQuery(collateKeysBy: ",");
Console.WriteLine(query); // fields=firstName,lastName
```
### Kralizek.Extensions.Http.Json
This package offers support for JSON payloads.
#### JSON payloads
The `JsonContent` class inherits from `System.Net.Http.HttpContent`, therefore it can be used to attach JSON payloads to an HTTP request.
The static factory method `FromObject` accepts any object and uses _Newtonsoft.Json_ to serialize it into a JSON object.
```csharp
var person = new Person
{
FirstName = "John",
LastName = "Doe"
};
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localtest.me:8080")
{
Content = JsonContent.FromObject(person)
};
using var response = await http.SendAsync(request);
```
#### HTTP REST Client
The `HttpRestClient` is an opinionated wrapper around the `HttpClient`.
Here are some advantages of using the `HttpRestClient`:
- it delegates the `HttpClient` instance management to `IHttpClientFactory`,
- offers methods to send HTTP requests with and without payload expecting or not a payload in the response,
- it embeds logging using the `Microsoft.Extensions.Logging` framework,
- it automatically handles serialization and deserialization to and from JSON payloads,
- it integrates nicely with the `Microsoft.Extensions.DependencyInjection` framework.
Here is a sample of its usage.
```csharp
var client = services.GetRequiredServices();
var person = await client.SendAsync(HttpMethod.Get, "/people/1", query);
```
In the snippet above, the call to the `SendAsync` method takes care of:
- getting an instance of `HttpClient` from the local `IHttpClientFactory`,
- assemble the HTTP request using the specified HTTP method, the path and the query from the previous snippet,
- log the HTTP request,
- send the HTTP request,
- receive the HTTP response,
- log the HTTP response,
- validate the result of the request via the status code of the HTTP response,
- deserialize the payload into an instance of the `Person` class,
- dispose all the resources that need disposing (`HttpRequestMessage` and `HttpResponseMessage`)
#### Setup
In the package there are different utilities that allow a simple yet powerful setup of the `HttpRestClient`.
```csharp
services.AddHttpRestClient("RequestBin", builder => builder
.ConfigureHttpClient(http =>
{
http.BaseAddress = new Uri("https://your-pipe.x.pipedream.net");
http.DefaultRequestHeaders.Add("X-Test", "This is a test");
})
.ConfigureHttpRestClient(options =>
{
options.ContentMediaType = JsonContent.ApplicationJsonMediaType;
})
.ConfigureSerialization(json =>
{
json.ContractResolver = new DefaultContractResolver
{
NamingStrategy = new CamelCaseNamingStrategy()
};
json.Formatting = Formatting.Indented;
}));
```
Since `AddHttpRestClient` accepts a delegate of type `Action`, you can leverage extensions to the `HttpClientFactory` API like [Polly](https://docs.microsoft.com/en-gb/aspnet/core/fundamentals/http-requests?view=aspnetcore-3.1#use-polly-based-handlers).
## Versioning
This library follows [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html) for the public releases (published to the [nuget.org](https://www.nuget.org/)).
## How to build
This project uses [Cake](https://cakebuild.net/) as a build engine. You will also need the [.NET Core SDK 3.1.401](https://dotnet.microsoft.com/).
If you would like to build this project locally, just execute the `build.cake` script.
You can do it by using the .NET tool created by CAKE authors and use it to execute the build script.
```powershell
dotnet tool restore
dotnet cake
```