https://github.com/thomaswormald/grpc-browser

A web UI for browsing and executing gRPC operations in your .NET application
https://github.com/thomaswormald/grpc-browser

grpc

Last synced: 3 months ago
JSON representation

A web UI for browsing and executing gRPC operations in your .NET application

• Host: GitHub
• URL: https://github.com/thomaswormald/grpc-browser
• Owner: thomaswormald
• License: mit
• Created: 2021-11-22T21:14:05.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-04-20T08:13:58.000Z (over 2 years ago)
• Last Synced: 2024-04-18T17:59:17.205Z (7 months ago)
• Topics: grpc
• Language: C#
• Homepage:
• Size: 1.03 MB
• Stars: 22
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-grpc - GrpcBrowser - a web UI for interactively debugging all types of gRPC endpoints (Language-Specific / C#)

README

        
# gRPC Browser

This project allows you to add a web-based gRPC Browser for debugging purposes to your .NET application.

![Example](docs/screenshots/fx_service.gif)

[Click here to view more screenshots](docs/screenshots.md)

## Features

1. Allows you to view and execute gRPC services in your .NET application

1. Supports both code-first gRPC and proto-first gRPC (with `.proto` files)

2. Does not use gRPC reflection or gRPC web

3. Support for all types of gRPC operation - Unary, Server Streaming, Client Streaming and Duplex

4. Support for Metadata

5. Support for [displaying documentation](docs/documentation.md)

### Future Roadmap

1. OAuth 2.0 support

## Usage

1. Add the package `GrpcBrowser` from NuGet to your project. Your project SDK must be Microsoft.NET.Sdk.Web (see Troubleshooting for further details).

2. In the configure method of your Startup class, add `app.UseGrpcBrowser();`

3. In the configure method of your Startup class, where you call `endpoints.MapGrpcService()`, add the following:

   1. For Code-First GRPC Services: `.AddToGrpcBrowserWithService()`

   2. For Proto-First (where you have defined a `.proto` file): `.AddToGrpcBrowserWithClient()`

4. In the `UseEndpoints()` setup, add `endpoints.MapGrpcBrowser()`

For example, the `Configure` method of a service with one proto-first and one code-first GRPC service could look like this:

```csharp

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)

{

    if (env.IsDevelopment())

    {

        app.UseDeveloperExceptionPage();

    }

    app.UseRouting();

    app.UseGrpcBrowser();

    app.UseEndpoints(endpoints =>

    {

        endpoints.MapGrpcService().AddToGrpcBrowserWithClient();

        endpoints.MapGrpcService().AddToGrpcBrowserWithService();

        endpoints.MapGrpcBrowser();

    });

}

```

5. In the `ConfigureServices` method of your Startup class, add `services.AddGrpcBrowser()`

6. Start your service, and navigate to `/grpc` in your browser.

[Click here for information on displaying documentation](docs/documentation.md)

## Troubleshooting

Example projects for .NET Core 3.1, .NET 5.0 and .NET 6.0 can be found in the `/src` folder.

### Error when navigating to `/grpc`

Make sure that your service SDK type is Microsoft.NET.Sdk.Web. This is required because GrpcBrowser adds server-side Blazor to your project. In the `.csproj` file, set the Project Sdk like this: ``

## Implementation Detail

The service reflects over the types provided to `AddToGrpcBrowserWithClient` or `AddToGrpcBrowserWithClient` in order to determine the available operations, meaning that gRPC reflection is not required. Because we use server-side Blazor, the request execution is done from the server, meaning that gRPC web is not required.