Protoc.Gateway 0.0.1-rc6

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher.
This is a prerelease version of Protoc.Gateway.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Protoc.Gateway --version 0.0.1-rc6                

                    
                

            
NuGet\Install-Package Protoc.Gateway -Version 0.0.1-rc6
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Protoc.Gateway" Version="0.0.1-rc6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Protoc.Gateway --version 0.0.1-rc6                

                    
                

            
#r "nuget: Protoc.Gateway, 0.0.1-rc6"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Protoc.Gateway as a Cake Addin
#addin nuget:?package=Protoc.Gateway&version=0.0.1-rc6&prerelease

// Install Protoc.Gateway as a Cake Tool
#tool nuget:?package=Protoc.Gateway&version=0.0.1-rc6&prerelease

Protoc.Gateway

Runtime gateway library from grpc to rest.

!> В разработке

Что это

Библиотека, которая парсит ассамблею, находит все grpc-клиентов и создает rest-обработчиков под каждый найденный rpc.

Поддерживает все типы rpc:

  • unary
  • server-stream
  • client-stream
  • duplex-stream

Поддерживает функционал авторизации в 3 вариациях:

  • jwt (с возможностью ограничения доступа к rpc на основании клаймов в токене)
  • basic
  • none

Также генерирует swagger(openapi) для всех намапленных в rest rpc.

А зачем это нужно

Мы ее используем в 3 сценариях:

  • Базис для rest-gateway решения в grpc окружении
  • Для локальной отладки при разработке grpc-сервисов через swagger
  • Для автоматического тестирования api grpc-сервисов с помощью rest

А как этим пользоваться

Устанавливаем nuget пакет

Добавляем grpc-клиентов в di:

builder.AddGrpcClients(typeof(MyGrpcExampleService).Assembly);

Где MyGrpcExampleService - любой тип из ассамблеи, содержащей grpc сервисы.

Добавляем swagger, собранный из этих этих grpc-клиентов:

builder.Services.AddSwagger(builder.Configuration, typeof(MyGrpcExampleService).Assembly, true);

Где MyGrpcExampleService - любой тип из ассамблеи, содержащей xml документацию для сгенерированных rpc.

Объявляем обработчиков для всех rpc и swagger:

app.UseSwagger();
app.UseSwaggerUI(c => c.SwaggerEndpoint("v1/swagger.yaml", "GrpcClients"));
app.MapGrpcClients();

Роадмап

  • Описать как использовать конфигурировать переменные окружения
  • Описать как использовать proto расширения
  • Описать как пользоваться jwt авторизаций
  • Описать как пользоваться basic авторизаций
  • Описать как использовать FileChunk
  • Перевести все это на кодогенерацию (в далеком будущем)
Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  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 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
0.0.3 115 4/3/2024
0.0.2 813 10/25/2023
0.0.1 140 10/22/2023
0.0.1-rc8 97 10/22/2023
0.0.1-rc7 108 10/22/2023
0.0.1-rc6 96 10/22/2023
0.0.1-rc5 115 10/22/2023
0.0.1-rc4 122 10/18/2023
0.0.1-rc3 97 10/18/2023
0.0.1-rc2 112 10/18/2023
0.0.1-rc1 103 10/17/2023