gRPC API Documentation
Document gRPC APIs with services, methods, four streaming types, proto message definitions, 17 status codes, 10 error detail types, interceptor chains, retry and hedging policies, HTTP transcoding, proto import and export, and a published gRPC API browser with streaming flow diagrams.
The gRPC editor documents gRPC APIs alongside your REST, GraphQL, AsyncAPI, Webhook, and MCP documentation. Define services, methods with all four streaming types, proto message schemas, error responses with google.rpc detail types, interceptor chains, retry and hedging policies, and HTTP transcoding rules in a structured format that publishes as a browsable gRPC API reference on your documentation site.
Core Concepts
gRPC API documentation is organised around three entity types with a shared schema layer for proto messages.
Four Streaming Types
Every gRPC method specifies its streaming type, which determines the request and response flow pattern.
Authentication
gRPC authentication separates channel-level credentials from per-call credentials, matching the gRPC security model.
Error Handling
Document error responses with the full google.rpc error model. Each method specifies which of the 17 standard gRPC status codes it may return, with descriptions and structured error details.
Advanced Features
Proto Import and Export
Viewer
The published site includes a gRPC API browser panel with dedicated viewers for API info, services, and methods.
Document REST APIs with full endpoint specifications, OpenAPI import and export, seven HTTP methods, parameters, request and response bodies linked to shared schemas, authentication schemes, and a published API browser. REST is one of six API types (REST, GraphQL, gRPC, AsyncAPI, Webhooks, MCP) sharing a unified schema layer.
Document GraphQL APIs with queries, mutations, subscriptions, custom scalars, directives, interfaces, and per-operation authentication in NeoArc Studio.
Document event-driven and asynchronous APIs with channels, operations, messages, protocol bindings for 18 protocols, 13 security schemes, reusable traits, and AsyncAPI 3.0 export in NeoArc Studio.
Define data structures with ten field types, 65+ type specialisations, and 50+ validation rules. Create reusable schemas that stay synchronised across your documentation.