gRPC Swagger
github.com
What it is
gRPC Swagger is a free, open-source debugging tool for discovering and calling gRPC methods through Swagger UI. It uses server reflection to scan a registered endpoint, identified by host and port, and then displays available services, method definitions, and parameters. Users can invoke methods with Swagger UI’s “Try it out” control, supplying request data and headers as JSON; the headers are passed to the gRPC server as metadata. Reflection must be enabled on the gRPC service, but the setup instructions say proto files and related implementations do not need modification. The project runs from a released JAR or from source and defaults to port 8080. Configuration can show registered services and expire inactive registrations after a chosen number of seconds. Documented endpoints cover registration, service listing, method calls, and Swagger documentation. It is self-hosted, available for API and web use, and licensed under MIT.
Spec sheet
- Purpose
- gRPC Swagger is a debugging tool that uses gRPC reflection and Swagger UI to list and call gRPC methods.Read 7 Oct 2026 · github.com
- Deployment
- The README documents running a released JAR or building from source, with port 8080 as the default.Read 7 Oct 2026 · github.com
- API
- The documented endpoints include service registration, listing services, calling a gRPC method, and returning API documentation for Swagger UI.Read 4 Oct 2026 · github.com
- Integrations
- The README describes integration with swagger-ui and use of the gRPC reflection feature.Read 7 Oct 2026 · github.com
- Support
- The README invites users to open an issue or pull request to contribute.Read 7 Oct 2026 · github.com
- License
- The repository provides the software under the MIT License.Read 7 Oct 2026 · github.com
- Configuration
- A setting can enable or disable listing registered services, and another can expire an inactive registered service after a specified number of seconds.Read 4 Oct 2026 · github.com
- Endpoint registration
- The tool registers a gRPC endpoint by host and port, then scans for available services.Read 4 Oct 2026 · github.com
- Latest listed release
- The releases page lists version 0.1.8 as the latest release and describes it as fixing duplicate services after registration.Read 7 Oct 2026 · github.com
- Metadata
- The tool accepts JSON-formatted request data and JSON-formatted headers that it passes as metadata to the gRPC server.Read 7 Oct 2026 · github.com
- Method calls
- Users can call a gRPC method through Swagger UI’s “Try it out” button.Read 7 Oct 2026 · github.com
- Method definitions
- Swagger UI displays gRPC method and parameter definitions.Read 7 Oct 2026 · github.com
- Method testing
- Users can test a gRPC method with the Swagger UI “Try it out” button.Read 4 Oct 2026 · github.com
- Notable requirement
- The gRPC service must have reflection enabled for the tool to discover its services and methods.Read 4 Oct 2026 · github.com
- Request format
- The request data and headers passed to the gRPC server are supplied in JSON format.Read 4 Oct 2026 · github.com
- Service definitions
- Swagger UI displays definitions of gRPC methods and their parameters.Read 4 Oct 2026 · github.com
- Service expiration
- A configurable expiration interval can remove a registered service after a period without access.Read 7 Oct 2026 · github.com
- Service listing
- A command-line parameter can enable listing registered services through the listServices API.Read 7 Oct 2026 · github.com
- Service registration
- Users register a gRPC endpoint by providing its host and port.Read 7 Oct 2026 · github.com
- Setup
- The README says users can enable reflection when starting their service without modifying proto files or related implementations.Read 7 Oct 2026 · github.com
- Support and contributions
- The project invites users to open an issue or pull request to contribute.Read 4 Oct 2026 · github.com
Plans and prices
Strong points and limits
Strong points
- Swagger UI lists methods and parameters
- Calls methods with JSON requests
- Supports service registration by host and port
- Runs from JAR or source
- MIT-licensed and free
Limits
- Reflection must be enabled on the service
- Defaults to port 8080
- No free trial is listed
- Self-hosted deployment is required
Who it suits
gRPC Swagger suits developers who need a browser-based way to inspect and exercise reflected gRPC services. It is useful when a self-hosted API or web debugging interface is acceptable.
Verdict
gRPC Swagger provides a focused Swagger interface for discovering and calling reflected gRPC services. Its main prerequisite is server reflection, while registration, testing, and service-listing controls cover the documented debugging workflow.
Where Specifiction places it
- gRPC Tools#7 of 248.1