grpc-docs
grpc-docs is an open-source project for interactive documentation of gRPC APIs, intended to fill a role similar to Swagger UI for gRPC.
What grpc-docs is
grpc-docs is an open-source project for interactive documentation of gRPC APIs, intended to fill a role similar to Swagger UI for gRPC. It can be added as a widget to an existing React frontend or run with Docker. Standalone setup uses JSON API descriptions generated from protobuf files with protoc-gen-doc. The project is free and licensed under MIT, and installation requires Node.js 12 or later. Its README also describes using a React component to connect grpc-docs with GenDocu Cloud and points to API documentation for creating a custom backend wrapper. The feature comparison distinguishes standalone use from use with GenDocu: code snippets and password-protected documentation are listed for the GenDocu option, but not for standalone grpc-docs. It lists one programming language for standalone and six with GenDocu. Environment selection and authentication descriptions are marked as not yet implemented in either configuration. RBAC-protected documentation and SSO are listed for GenDocu Developer Portal, not for grpc-docs standalone or with GenDocu.
Good
- Can run as a React widget or with Docker.
- Accepts JSON descriptions generated from protobuf files.
- MIT-licensed and free to use.
Watch out
- Standalone use lacks code snippets and password-protected documentation.
- Environment selection and authentication descriptions are not yet implemented.
- Standalone installation requires Node.js 12 or later.
Who it suits
grpc-docs suits developers who need interactive gRPC API documentation in a React frontend or Docker deployment. Standalone users should be comfortable supplying JSON descriptions generated from protobuf files.
Verdict
grpc-docs offers a self-hosted route to interactive gRPC API documentation, with a documented GenDocu connection and custom-backend option. Its listed feature gaps are worth checking against your documentation and access-control needs.
The facts
Each one read from grpc-docs's own pages, with the date it was checked.
What it does
- Access configuration
- The README says the documentation host must be added in GenDocu project settings when an origin is rejected.checked 9 Oct 2026
- Access controls
- The comparison lists RBAC-protected documentation and SSO for GenDocu Developer Portal, but not for grpc-docs standalone or with GenDocu.checked 4 Oct 2026
- Authentication input
- For standalone use, an API definition can be fetched with authorization headers and passed to the component as text.checked 9 Oct 2026
- Custom backend
- The README says users can implement their own backend wrapper and links to API documentation.checked 9 Oct 2026
- Docker
- The README provides a Docker quickstart that mounts a proto root as input and writes generated output to a local output directory.checked 9 Oct 2026
- Feature comparison
- The comparison lists code snippets and password-protected documentation for grpc-docs with GenDocu, while standalone grpc-docs lacks both.checked 4 Oct 2026
- Feature limits
- In the README comparison, standalone gRPC-docs lacks code snippets and password-protected documentation; several capabilities are marked as planned.checked 9 Oct 2026
- GenDocu feature limits
- The comparison lists RBAC-protected documentation and SSO for GenDocu Developer Portal, but not for gRPC-docs with GenDocu.checked 9 Oct 2026
- GenDocu integration
- The README supports a GenDocu Cloud integration through the GRPCGenDocuAPIReference React component.checked 9 Oct 2026
- Input format
- Standalone setup uses JSON API descriptions generated from protobuf definitions with protoc-gen-doc.checked 9 Oct 2026
- Language support
- The comparison lists one programming language for standalone grpc-docs and six for grpc-docs with GenDocu.checked 4 Oct 2026
- License
- The repository README identifies the project as MIT licensed.checked 9 Oct 2026
- Notable limits
- The comparison marks environment selection and authentication descriptions as not yet implemented for standalone grpc-docs and grpc-docs with GenDocu.checked 4 Oct 2026
- Package install
- The README documents installation through npm or Yarn and specifies Node.js 12 or later.checked 9 Oct 2026
- Purpose
- grpc-docs provides interactive gRPC API documentation, described as similar to Swagger UI for gRPC APIs.checked 9 Oct 2026
- Runtime requirement
- The README says installation requires Node.js 12 or later.checked 4 Oct 2026
- Standalone use
- The library can be embedded in an existing React frontend as an API reference component.checked 9 Oct 2026
Alternatives to grpc-docs
- 1
Kreya
Free planLinuxmacOSWindows7.1Free plan - 2
Bandura
Free planLinuxmacOSSelf-hostedWindows6.7$59 one-time - 3
grpcmd
Free planLinuxmacOSWindows6.7From $9 a year - 4
FintX
Free planLinuxmacOSWindows6.6Free plan - 5
grpcui
Free planWebLinuxmacOSSelf-hosted6.6Free plan - 6
protoc-gen-doc
Free planLinuxmacOSSelf-hostedWindows6.5Free plan