pkg
max-ieremenko/ServiceModel.Grpc.AspNetCore.Swashbucklev1.21.0
.NET 8.0.NET 9.0.NET 10.0
Library that enables applications to communicate with gRPC services using code-first approach, helps to get around some limitations of gRPC protocol. Provides exception handling. Helps to migrate existing WCF solution to gRPC with minimum effort.
Get Started
$ dotnet add package ServiceModel.Grpc.AspNetCore.SwashbuckleReadme
ServiceModel.Grpc.AspNetCore.Swashbuckle
ServiceModel.Grpc enables applications to communicate with gRPC services using a code-first approach (no .proto files), helps to get around limitations of gRPC protocol like "only reference types", "exact one input", "no nulls", "no value-types". Provides exception handling. Helps to migrate existing WCF solution to gRPC with minimum effort.
ServiceModel.Grpc.AspNetCore.Swashbuckle is package with Swashbuckle.AspNetCore integration for ServiceModel.Grpc.AspNetCore.
Declare a service contract and implement service
A service contract is an interface decorated with the ServiceContract attribute. Interface methods decorated with the OperationContract attribute are treated as gRPC operations.
For example, following ICalculator contract with unary Sum operation and client streaming MultiplyBy operation:
[ServiceContract]
public interface ICalculator
{
[OperationContract]
Task<long> Sum(long x, int y, int z, CancellationToken token = default);
[OperationContract]
ValueTask<(int Multiplier, IAsyncEnumerable<int> Values)> MultiplyBy(IAsyncEnumerable<int> values, int multiplier, CancellationToken token = default);
}
internal sealed class Calculator : ICalculator
{
public Task<long> Sum(long x, int y, int z, CancellationToken token)
{
...
}
public ValueTask<(int Multiplier, IAsyncEnumerable<int> Values)> MultiplyBy(IAsyncEnumerable<int> values, int multiplier, CancellationToken token)
{
...
}
}
Configure Swashbuckle.AspNetCore
Enable ServiceModel.Grpc code-first and Swashbuckle.AspNetCore integration, add service to the routing pipeline.
var builder = WebApplication.CreateBuilder();
// Swashbuckle.AspNetCore
builder.Services.AddMvc();
builder.Services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "1.0" });
c.EnableAnnotations(true, true);
c.UseAllOfForInheritance();
c.SchemaGeneratorOptions.SubTypesSelector = SwaggerTools.GetDataContractKnownTypes;
});
// enable ServiceModel.Grpc code-first
builder.Services.AddServiceModelGrpc(options => { ... });
// enable ServiceModel.Grpc integration for Swashbuckle.AspNetCore
builder.Services.AddServiceModelGrpcSwagger();
var app = builder.Build();
// Swashbuckle.AspNetCore
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("v1/swagger.json", "1.0");
});
// Enable ServiceModel.Grpc HTTP/1.1 JSON gateway for Swagger UI, button "Try it out"
app.UseServiceModelGrpcSwaggerGateway();
// bind the service
app.MapGrpcService<Calculator>();
app.Run();
