grpc-docs
What grpc-docs is
grpc-docs is an open-source tool for interactive documentation of gRPC APIs. It can be embedded as a widget in an existing React frontend or run with Docker. In standalone use, it takes JSON API descriptions generated from protobuf files with protoc-gen-doc. The README also describes connecting it to GenDocu Cloud through a React component and building a custom backend wrapper. The project is self-hosted, free under the MIT license, and supports Linux and web use. Installation through npm or Yarn requires Node.js 12 or later. The README comparison says standalone grpc-docs does not include code snippets or password-protected documentation, while those are listed for grpc-docs with GenDocu. It lists one programming language for standalone and six with GenDocu. Environment selection and authentication descriptions are marked as not yet implemented in both configurations. For standalone use, an API definition can be fetched with authorization headers and passed to the component as text.
Who it suits
It suits developers who want to publish interactive gRPC API documentation within a React frontend or through a Docker deployment. Teams that need code snippets or password-protected documentation should account for the listed configuration differences.
What it does well
- Free and licensed under MIT
- Can run as a React widget or with Docker
- Accepts JSON descriptions generated from protobuf files
- Custom backend wrapper is supported
What to know first
- Standalone version lacks code snippets
- Standalone version lacks password-protected documentation
- Environment selection is not yet implemented
- Authentication descriptions are not yet implemented
Limits
Standalone grpc-docs lacks code snippets and password-protected documentation. Environment selection and authentication descriptions are marked as not yet implemented in standalone and GenDocu configurations.
Getting started
- Visit the GitHub repository at https://github.com/gendocu-com/grpc-docs.
- Install Node.js 12 or later for npm or Yarn installation.
- Install through npm or Yarn, or use the Docker quickstart.
- For standalone use, generate JSON API descriptions from protobuf files with protoc-gen-doc.
- Add it to a React frontend, or run it with Docker.
Verdict
grpc-docs provides a self-hosted path to interactive gRPC API documentation, with React and Docker deployment options. Its comparison lists several capabilities as absent or not yet implemented, so check those limits against the documentation needs of your project.
Questions
Is grpc-docs free and open source?
Yes. The project is free and the repository is licensed under MIT.
Which platforms are listed?
Linux and web are listed.
How can I run grpc-docs?
It can be used as a widget in an existing React frontend or run with Docker. Package installation through npm or Yarn requires Node.js 12 or later.
What input does standalone grpc-docs use?
It uses JSON API descriptions generated from protobuf files with protoc-gen-doc.
Does standalone grpc-docs include code snippets and password protection?
No. The comparison lists those for grpc-docs with GenDocu, but not for standalone grpc-docs.
Does grpc-docs include RBAC protection or SSO?
The comparison lists RBAC-protected documentation and SSO for GenDocu Developer Portal, not for grpc-docs standalone or with GenDocu.
Facts from grpc-docs's own pages
- Access configuration
- The README says the documentation host must be added in GenDocu project settings when an origin is rejected. · github.com, 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. · github.com, 4 Oct 2026
- Authentication input
- For standalone use, an API definition can be fetched with authorization headers and passed to the component as text. · github.com, 9 Oct 2026
- Custom backend
- The README says users can implement their own backend wrapper and links to API documentation. · github.com, 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. · github.com, 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. · github.com, 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. · github.com, 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. · github.com, 9 Oct 2026
- GenDocu integration
- The README supports a GenDocu Cloud integration through the GRPCGenDocuAPIReference React component. · github.com, 9 Oct 2026
- Input format
- Standalone setup uses JSON API descriptions generated from protobuf definitions with protoc-gen-doc. · github.com, 9 Oct 2026
- Language support
- The comparison lists one programming language for standalone grpc-docs and six for grpc-docs with GenDocu. · github.com, 4 Oct 2026
- License
- The repository README identifies the project as MIT licensed. · github.com, 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. · github.com, 4 Oct 2026
- Package install
- The README documents installation through npm or Yarn and specifies Node.js 12 or later. · github.com, 9 Oct 2026
- Purpose
- grpc-docs provides interactive gRPC API documentation, described as similar to Swagger UI for gRPC APIs. · github.com, 9 Oct 2026
- Runtime requirement
- The README says installation requires Node.js 12 or later. · github.com, 4 Oct 2026
- Standalone use
- The library can be embedded in an existing React frontend as an API reference component. · github.com, 9 Oct 2026
Where grpc-docs stands on Freedom251
- gRPC Tools#23 of 24