Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/byndyusoft/byndyusoft.net.http.messagepack
Provides extension methods for System.Net.Http.HttpClient and System.Net.Http.HttpContent that perform automatic serialization and deserialization using MessagePack.
https://github.com/byndyusoft/byndyusoft.net.http.messagepack
aspnet byndyusoft http messagepack
Last synced: 22 days ago
JSON representation
Provides extension methods for System.Net.Http.HttpClient and System.Net.Http.HttpContent that perform automatic serialization and deserialization using MessagePack.
- Host: GitHub
- URL: https://github.com/byndyusoft/byndyusoft.net.http.messagepack
- Owner: Byndyusoft
- License: mit
- Created: 2020-11-25T16:57:42.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-17T14:05:16.000Z (about 1 month ago)
- Last Synced: 2024-12-17T14:19:08.254Z (about 1 month ago)
- Topics: aspnet, byndyusoft, http, messagepack
- Language: C#
- Homepage: https://en.byndyusoft.com
- Size: 77.1 KB
- Stars: 1
- Watchers: 16
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[MessagePack](https://www.nuget.org/packages/MessagePack/) is an efficient binary serialization format. It lets you exchange data among multiple languages like JSON. But it's faster and smaller.
Small integers are encoded into a single byte, and typical short strings require only one extra byte in addition to the strings themselves.
## Byndyusoft.Net.Http.MessagePack
[](LICENSE.txt)
[](https://www.nuget.org/packages/Byndyusoft.Net.Http.MessagePack/) [](https://www.nuget.org/packages/Byndyusoft.Net.Http.MessagePack/)
Provides extension methods for System.Net.Http.HttpClient and System.Net.Http.HttpContent that perform automatic serialization and deserialization using MessagePack.
This package actually depends on ```Microsoft.Net.Http```, and extends the ```HttpClient``` with ```MessagePack```
features that you would likely need to talk to a RESTful service such as ASP.NET Web API.
Package operates in the ```System.Net.Http``` namespace and adds some handy extension methods to ```HttpClient``` and ```HttpContent```.
So for example:
```csharp
using (var client = new HttpClient())
{
var product = await client.GetFromMessagePackAsync("http://localhost/api/products/1");
}
```
or
```csharp
using (var client = new HttpClient())
{
var response = await _client.GetAsync("http://localhost/api/products/1");
response.EnsureSuccessStatusCode();
var product = await response.Content.ReadFromMessagePackAsync();
}
```
or
```csharp
using (var client = new HttpClient())
{
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost/api/products/1");
request.Content = MessagePackContent.Create(new Product());
var response = await _client.SendAsync(request);
response.EnsureSuccessStatusCode();
}
```
If you tried to just use ```Microsoft.Net.Http```, the ```GetFromMessagePackAsync``` method wouldn't be available to you, and you'd only be able to read the content
as raw data such as bytes or string, and have to do the serializing / de-serializing yourself.
You also get extension methods to PUT / POST back to the service in ```MessagePack``` format without having to do that yourself:
```csharp
await client.PutAsMessagePackAsync("http://localhost/api/products/1", product);
await client.PostAsMessagePackAsync("http://localhost/api/products/1", product);
```
This package also adds `MessagePackMediaTypeFormatter` class for formatting `HttpClient` requests and responses:
```csharp
using (var client = new HttpClient())
{
var formatter = new MessagePackMediaTypeFormatter();
var request = new SearchProductRequest { Name = 'iphone', OrderBy = 'id' };
var content = new ObjectContent(request, formatter);
var response = await client.PostAsync("http://localhost/api/products:search", content);
var products = await response.Content.ReadAsAsync(new[] {formatter});
}
```
### Installing
```shell
dotnet add package Byndyusoft.Net.Http.MessagePack
```
***
# Contributing
To contribute, you will need to setup your local environment, see [prerequisites](#prerequisites). For the contribution and workflow guide, see [package development lifecycle](#package-development-lifecycle).
A detailed overview on how to contribute can be found in the [contributing guide](CONTRIBUTING.md).
## Prerequisites
Make sure you have installed all of the following prerequisites on your development machine:
- Git - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.
- .NET (version 8.0 or higher) - [Download & Install .NET](https://dotnet.microsoft.com/en-us/download/dotnet/8.0).
## General folders layout
### src
- source code
### tests
- unit-tests
## Package development lifecycle
- Implement package logic in `src`
- Add or addapt unit-tests (prefer before and simultaneously with coding) in `tests`
- Add or change the documentation as needed
- Open pull request in the correct branch. Target the project's `master` branch
# Maintainers
[[email protected]](mailto:[email protected])