Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/protobuf-net/protobuf-net.Grpc
GRPC bindings for protobuf-net and grpc-dotnet
https://github.com/protobuf-net/protobuf-net.Grpc
Last synced: 7 days ago
JSON representation
GRPC bindings for protobuf-net and grpc-dotnet
- Host: GitHub
- URL: https://github.com/protobuf-net/protobuf-net.Grpc
- Owner: protobuf-net
- License: other
- Created: 2019-06-16T20:40:32.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-02-12T22:29:34.000Z (9 months ago)
- Last Synced: 2024-05-16T05:37:03.056Z (6 months ago)
- Language: C#
- Size: 2.34 MB
- Stars: 841
- Watchers: 42
- Forks: 107
- Open Issues: 116
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 
protobuf-net.Grpc
[](https://ci.appveyor.com/project/StackExchange/protobuf-net-grpc/branch/main)
`protobuf-net.Grpc` adds code-first support for services over gRPC using either the native `Grpc.Core` API, or the fully-managed `Grpc.Net.Client` / `Grpc.AspNetCore.Server` API.
It should work on all .NET languages that can generate something *even remotely like* a regular .NET type model.
- [Getting Started](https://protobuf-net.github.io/protobuf-net.Grpc/gettingstarted)
- [All Documentation](https://protobuf-net.github.io/protobuf-net.Grpc/)
- [Build/usage available via `protobuf-net.BuildTools`](https://protobuf-net.github.io/protobuf-net/build_tools)
Usage is as simple as declaring an interface for your service-contract:
``` c#
[ServiceContract]
public interface IMyAmazingService {
ValueTask SearchAsync(SearchRequest request);
// ...
}
```
then either implementing that interface for a server:
``` c#
public class MyServer : IMyAmazingService {
// ...
}
```
or asking the system for a client:
``` c#
var client = http.CreateGrpcService();
var results = await client.SearchAsync(request);
```
This would be equivalent to the service in .proto:
``` proto
service MyAmazingService {
rpc Search (SearchRequest) returns (SearchResponse) {}
// ...
}
```
Obviously you need to tell it the uri etc - see [Getting Started](https://protobuf-net.github.io/protobuf-net.Grpc/gettingstarted). Usually the configuration is convention-based, but
if you prefer: there are [various configuration options](https://protobuf-net.github.io/protobuf-net.Grpc/configuration).
## Getting hold of it
Everything is available as pre-built packages on nuget; in particular, you probably want one of:
- [`protobuf-net.Grpc.AspNetCore`](https://www.nuget.org/packages/protobuf-net.Grpc.AspNetCore) for servers using ASP.NET Core 3.1
- [`protobuf-net.Grpc.Native`](https://www.nuget.org/packages/protobuf-net.Grpc.Native) for clients or servers using the native/unmanaged API
- [`protobuf-net.Grpc`](https://www.nuget.org/packages/protobuf-net.Grpc) and [`Grpc.Net.Client`](https://www.nuget.org/packages/Grpc.Net.Client/) for clients using `HttpClient` on .NET Core 3.1
[Usage examples are available in C#, VB and F#](https://github.com/protobuf-net/protobuf-net.Grpc/tree/main/examples/pb-net-grpc).
## Anything else?
`protobuf-net.Grpc` is created and maintained by [Marc Gravell](https://github.com/mgravell) ([@marcgravell](https://twitter.com/marcgravell)), the author of `protobuf-net`.
It makes use of tools from [grpc](https://github.com/grpc/), but is not official associated with, affiliated with, or endorsed by that project.
I look forward to your feedback, and if this could save you a ton of time, you're always welcome to [](https://www.buymeacoffee.com/marcgravell)