+0
Daily
5,934
stars
426
forks
55
watchers
308
prs
148
issues
17
releases
README
gRPC UI grpcui is a command-line tool that lets you interact with gRPC servers via a browser. It's sort of like Postman, but for gRPC APIs instead of REST. In some ways, this is like an extension to grpcurl. Whereas grpcurl is a command-line interface, grpcui provides a web/browser-based GUI. This lets you interactively construct requests to send to a gRPC server. With this tool you can also browse the schema for gRPC services, which is presented as a list of available endpoints. This is enabled either by querying a server that supports server reflection, by reading proto source files, or by loading in compiled "protoset" files (files that contain encoded file descriptor protos). In fact, the way the tool transforms JSON request data into a binary encoded protobuf is using that very same schema. So, if the server you interact with does not support reflection, you will either need the proto source files that define the service or need protoset files that grpcui can use. This repo also provides two library packages 1. github.com/fullstorydev/grpcui: This package contains the building blocks for embedding a gRPC web form into any Go HTTP server. It has functions for accessing the HTML form, the JavaScript code that powers it, as well as a sample CSS file, for styling the form. 2. github.com/fullstorydev/grpcui/standalone: This package goes a step further and supplies a single, simple HTTP handler that provides the entire gRPC web UI. You can just wire this handler into your HTTP server to embed a gRPC web page that looks exactly like the one you see when you use the grpcui command-line program. This single handler uses the above package but also supplies the enclosing HTML page, some other script dependencies (jQuery and jQuery-UI), and additional CSS and image resources. Features grpcui supports all kinds of RPC methods, including streaming methods. However, it requires you to construct the entire stream of request messages all at once and then renders the entire resulting stream of response messages all at once (so you can't interact with bidirectional streams the way that grpcurl can). grpcui supports both plain-text and TLS servers and has numerous options for TLS configuration. It also supports mutual TLS, where the client is required to present a client certificate. As mentioned above, grpcui works seamlessly if the server supports the reflection service. If not, you can supply the .proto source files or you can supply protoset files (containing compiled descriptors, produced by protoc) to grpcui. The web UI allows you to set request metadata in addition to defining the request message data. When defining request message data, it uses a dynamic HTML form that supports data entry for all possible kinds of protobuf messages, including rich support for well-known types (such as google.protobuf.Timestamp), one ofs, and maps. In addition to entering the data via HTML form, you can also enter the data in JSON format,
Top issues
#40Symbol not found: grpc.reflection.v1alpha.ServerReflection16 comments · 2019-06-14#206Filling protobuf.any value in grpcui9 comments · 2022-11-25#105com.google.protobuf.Any support?9 comments · 2021-01-27#201Grpcui image does not have shell, ssh and cp comman. It would be usefull to copy protoset to image.6 comments · 2022-09-16#175Unable to get UI to render error details.6 comments · 2022-03-11#53Example of using the standalone application will be great6 comments · 2019-10-08#46Incompatible with validators 6 comments · 2019-08-02#3Copy as "grpcurl"6 comments · 2018-12-03
Latest release
v1.5.4 v1.5.4 2026-09-02[!NOTE] This is a re-release of 1.5.3 for an incorrect tag situation. Same notes are re-added below What's Changed Dependencies Bump golang.org/x/net from 0.56.0 to 0.58.0 by @dependabot[bot] in https://github.com/fullstorydev/grpcui/pull/439 Bump google.golang.org/protobuf from 1.36.11 to 1.36.12 by @dependabot[bot] in https://github.com/fullstorydev/grpcui/pull/440 Changes go mod update by @dragonsinth in https://github.com/fullstorydev/grpcui/pull/441 use actions to cut releases and generate artifacts by @SamKirsch10 in https://github.com/fullstorydev/grpcui/pull/443