fullstorydev/grpcui
Grpcui
grpcui is a browser-based interactive web interface and API client for executing remote procedure calls to gRPC servers. It functions as an HTTP to gRPC gateway that translates JSON payloads into binary protobuf messages, allowing users to trigger network requests and inspect responses through a visual web interface.
The tool provides schema browsing and discovery capabilities by querying server reflection or loading local protobuf descriptor files to identify available services and method signatures. It uses these definitions to automatically generate dynamic input forms for constructing request data, including support for complex nested structures.
The project covers API testing and client debugging, enabling the review of response bodies, status codes, and metadata headers. It also manages secure connectivity through a transport layer that supports plain text, TLS, and mutual authentication with configurable client certificates.
Features
- HTTP-to-gRPC Transcoding - Acts as a gateway that translates standard HTTP web requests into gRPC service calls.
- gRPC API Testing - Provides a visual web interface for verifying gRPC server functionality by sending requests and inspecting responses.
- JSON-Protobuf Mapping - Converts structured JSON request bodies into the binary wire format required for remote procedure calls.
- Definition Loading - Resolves communication endpoints by loading service definitions from server reflection, source files, or binary descriptors.
- gRPC GUI Clients - Acts as a graphical user interface for interacting with and testing gRPC service endpoints.
- gRPC Request Debugging - Facilitates troubleshooting of gRPC communication by allowing manual editing of requests and review of metadata.
- gRPC Schema Browsers - Offers a visual tool for exploring available gRPC services and method signatures using server reflection or proto files.
- Interactive Execution Interfaces - Provides an interactive interface for selecting services and defining messages to trigger network calls.
- Descriptor-Based Resolution - Resolves available network endpoints by parsing compiled binary descriptors or local proto files.
- Interactive Web Interfaces - Provides a browser-based interface for interacting with gRPC services using dynamic forms and JSON editing.
- Method Invocation - Provides the ability to trigger gRPC methods by translating JSON payloads into remote procedure calls.
- gRPC Service Discovery - Discovers available gRPC services and methods using server reflection or local descriptors.
- Remote Procedure Calls - Executes remote procedure calls against a running server via a web-based interface.
- Remote Procedure Invocation Systems - Implements a system for executing remote procedures by converting browser-based JSON payloads into gRPC requests.
- Schema Descriptor Retrieval - Fetches binary file descriptors from remote servers to define service signatures and method structures.
- Dynamic Form Mapping - Automatically generates dynamic web input forms by parsing protobuf descriptors to match message structures.
- Server Reflection - Queries a remote server's reflection service to retrieve method signatures and message definitions dynamically.
- Dynamic Form Generation - Creates interactive input fields by mapping protobuf message definitions to a web-based user interface.
- gRPC - Enables discovery of available gRPC network endpoints using server reflection or local protobuf source files.
- RPC Request Forms - Provides web-based forms for constructing structured request messages including complex types and maps.
- Request Data Handling - Allows the definition of request messages, including nested structures, through a dynamic interface.
- Browser gRPC Clients - Provides a browser-based client that enables web browsers to call gRPC services via an HTTP proxy.
- UI Schema Mapping - Links protobuf type definitions to a browser UI to allow editing of complex nested data structures.
- Request Execution - Transmits requests to servers using standard, streaming, or bidirectional communication methods.
- Response Formatting - Translates binary gRPC responses into human-readable formats for inspection and debugging.
- gRPC and HTTP TLS Securings - Secures client-to-server communication using TLS with configurable certificates and mutual authentication.
- Mutual TLS Configurations - Supports mutual TLS configurations for client-side certificate authentication and secure handshakes.
- Mutual TLS Transports - Manages secure communication channels using mutual TLS authentication and custom certificates.
- Secure Connection Handlers - Manages secure connectivity using TLS encryption, certificate validation, and credential handling.
- Request Body Editors - Includes a text editor to manually modify JSON request bodies before transmission.
- Response Inspection Tools - Provides utilities for inspecting gRPC response bodies, status codes, and metadata headers.
- API Clients - Web-based interface for testing gRPC services.
- Graphical Interfaces - Interactive web UI for gRPC services.
- RPC Frameworks - Browser-based UI for interacting with gRPC services.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
