Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/byndyusoft/byndyusoft.aspnetcore.mvc.formatters.protobuf
ASP.NET Core MVC formatters for ProtoBuf input and output.
https://github.com/byndyusoft/byndyusoft.aspnetcore.mvc.formatters.protobuf
aspnet aspnetcore byndyusoft formatters mvc protobuf
Last synced: about 1 month ago
JSON representation
ASP.NET Core MVC formatters for ProtoBuf input and output.
- Host: GitHub
- URL: https://github.com/byndyusoft/byndyusoft.aspnetcore.mvc.formatters.protobuf
- Owner: Byndyusoft
- License: mit
- Created: 2021-10-20T18:12:44.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-18T14:43:49.000Z (about 2 months ago)
- Last Synced: 2024-12-18T15:39:25.980Z (about 2 months ago)
- Topics: aspnet, aspnetcore, byndyusoft, formatters, mvc, protobuf
- Language: C#
- Homepage: https://en.byndyusoft.com
- Size: 44.9 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Byndyusoft.AspNetCore.Mvc.Formatters.ProtoBuf
ASP.NET Core MVC formatters for ProtoBuf input and output.
[](LICENSE.txt)
[](https://www.nuget.org/packages/Byndyusoft.AspNetCore.Mvc.Formatters.ProtoBuf/) [](https://www.nuget.org/packages/Byndyusoft.AspNetCore.Mvc.Formatters.ProtoBuf/)
[Protocol Buffers](https://developers.google.com/protocol-buffers) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data – think XML, but smaller, faster, and simpler.
## Content negotiation
Content negotiation occurs when the client specifies an `Accept` header. The default format used by ASP.NET Core is JSON. But client can specify `ProtoBuf` format:
```csharp
using (var httpClient = new HttpClient())
{
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/protobuf"));
var response = await client.GetAsync("/api/products/5");
var product = response.Content.ReadFromProtoBufAsync();
}
```
In this example [Byndyusoft.Net.Http.ProtoBuf](https://www.nuget.org/packages/Byndyusoft.Net.Http.ProtoBuf/) package is used.
## Configure formatters
Asp.NET Core Apps that need to support ProtoBuf format can add the `Byndyusoft.AspNetCore.Mvc.Formatters.ProtoBuf` NuGet packages and configure support.
There are separate formatters for input and output. Input formatters are used by [Model Binding](https://docs.microsoft.com/en-us/aspnet/core/mvc/models/model-binding). Output formatters are used to format responses.
## Installing
```shell
dotnet add package Byndyusoft.AspNetCore.Mvc.Formatters.ProtoBuf
```
## Add ProtoBuf format support to Asp.Net
ProtoBuf formatters implemented using `ProtoBufSerializer` are configured by calling `AddProtoBufFormatters`:
```csharp
public void ConfigureServices(IServiceCollection services)
{
services.AddMvcCore()
.AddProtoBufFormatters();
}
```
The preceding code serializes results using `ProtoBufSerializer`.
## Response format URL mappings
Clients can request a particular format as part of the URL, for example:
* In the query string or part of the path.
* By using a format-specific file extension such as .json or .protobuf.
The mapping from request path should be specified in the route the API is using. For example:
```csharp
[Route("api/[controller]")]
[ApiController]
[FormatFilter]
public class ProductsController : ControllerBase
{
[HttpGet("{id}.{format?}")]
public Product Get(int id)
{
```
The preceding route allows the requested format to be specified as an optional file extension.
The `[FormatFilter]` attribute checks for the existence of the format value in the RouteData and maps the response format to the appropriate formatter when the response is created.
| Route| Formatter |
| ---- | --------- |
| /api/products/5 | The default output formatter |
| /api/products/5.json | The JSON formatter (if configured) |
| /api/products/5.protobuf | The ProtoBuf formatter (if configured) |
# 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 Core](https://dotnet.microsoft.com/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])