ServiceModel.Grpc.AspNetCore.Swashbuckle
1.11.1
dotnet add package ServiceModel.Grpc.AspNetCore.Swashbuckle --version 1.11.1
NuGet\Install-Package ServiceModel.Grpc.AspNetCore.Swashbuckle -Version 1.11.1
<PackageReference Include="ServiceModel.Grpc.AspNetCore.Swashbuckle" Version="1.11.1" />
paket add ServiceModel.Grpc.AspNetCore.Swashbuckle --version 1.11.1
#r "nuget: ServiceModel.Grpc.AspNetCore.Swashbuckle, 1.11.1"
// Install ServiceModel.Grpc.AspNetCore.Swashbuckle as a Cake Addin #addin nuget:?package=ServiceModel.Grpc.AspNetCore.Swashbuckle&version=1.11.1 // Install ServiceModel.Grpc.AspNetCore.Swashbuckle as a Cake Tool #tool nuget:?package=ServiceModel.Grpc.AspNetCore.Swashbuckle&version=1.11.1
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();
Links
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. |
-
net6.0
- ServiceModel.Grpc.AspNetCore (>= 1.11.1)
- Swashbuckle.AspNetCore.SwaggerGen (>= 7.0.0)
-
net8.0
- ServiceModel.Grpc.AspNetCore (>= 1.11.1)
- Swashbuckle.AspNetCore.SwaggerGen (>= 7.0.0)
-
net9.0
- ServiceModel.Grpc.AspNetCore (>= 1.11.1)
- Swashbuckle.AspNetCore.SwaggerGen (>= 7.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.11.1 | 217 | 11/30/2024 |
1.11.0 | 260 | 11/23/2024 |
1.10.1 | 2,285 | 10/19/2024 |
1.9.1 | 854 | 9/29/2024 |
1.9.0 | 3,160 | 7/21/2024 |
1.8.3 | 4,376 | 5/18/2024 |
1.8.2 | 2,758 | 3/2/2024 |
1.8.1 | 2,116 | 2/13/2024 |
1.8.0 | 3,174 | 1/7/2024 |
1.7.0 | 503 | 12/24/2023 |
1.6.1 | 6,216 | 11/25/2023 |
1.6.0 | 6,416 | 9/9/2023 |
1.5.2 | 5,865 | 6/25/2023 |
1.5.1 | 5,767 | 5/1/2023 |
1.5.0 | 4,668 | 3/7/2023 |
1.4.13 | 5,041 | 12/19/2022 |
1.4.12 | 1,153 | 11/19/2022 |
1.4.11 | 875 | 10/23/2022 |
1.4.10 | 628 | 8/14/2022 |
1.4.9 | 491 | 7/23/2022 |
1.4.8 | 443 | 5/29/2022 |
1.4.7 | 418 | 5/21/2022 |
1.4.6 | 482 | 4/3/2022 |
1.4.5 | 455 | 3/26/2022 |
1.4.4 | 529 | 3/12/2022 |
1.4.3 | 492 | 2/5/2022 |
1.4.2 | 602 | 1/22/2022 |
1.4.1 | 282 | 1/8/2022 |
1.4.0 | 2,493 | 11/26/2021 |
1.3.2 | 407 | 11/5/2021 |
1.3.1 | 446 | 10/10/2021 |
1.3.0 | 472 | 7/31/2021 |
1.2.1 | 498 | 6/12/2021 |
1.2.0-pre1 | 274 | 6/6/2021 |