For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Book a demoLog inStart for free
  • Getting started
    • Overview
    • How it works
    • Quickstart
    • Project structure
    • Customer showcase
    • Changelog
  • Configuration
    • Overview
    • Site-level settings
    • Page-level settings
  • Writing content
    • Markdown basics
    • Rich media in Markdown
    • Fern Editor
    • Reusable snippets
  • AI features
    • Overview
    • Fern Writer
    • AI-generated examples
    • Markdown access
      • Overview
      • Customize LLM output
      • Agent directives
      • Analytics and integration
    • MCP server
    • API catalog discovery
      • Overview
        • REST API Reference
        • Webhook Reference
        • WebSocket Reference
        • OpenRPC Reference
        • gRPC Reference
        • GraphQL Reference
        • Library Reference
  • Public API
    • GETJWT from Fern API key
    • GETAlgolia search credentials
    • GETCurrent user information
  • Fern Writer API
    • GETGet Fern Writer Install Link
Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricing

Company

Brand KitPrivacy PolicyTerms of Service
LogoLogo
Book a demoLog inStart for free
On this page
  • Configuration
  • Include more than one gRPC Reference
  • Configuration properties
API ReferencesGeneration

Generate gRPC API Reference

||View as Markdown|
Was this page helpful?
Edit this page
Previous

Generate OpenRPC Reference

Next

Generate GraphQL Reference

Fern generates gRPC API Reference documentation from your Protocol Buffer (.proto) files. Add your .proto files to your Fern project and Fern renders services, RPCs, messages, and types as an interactive reference.

Configuration

1

Set up your project structure

Add your .proto files to your /fern directory and create a generators.yml that references them:

generators.yml
1api:
2 specs:
3 - proto:
4 root: ./proto
5 target: proto/service/v1/service.proto
2

Add the gRPC Reference to your navigation

Add - api: API Reference to your navigation in docs.yml:

docs.yml
1navigation:
2 - api: API Reference

Fern will automatically populate your services, RPCs, message types, and enums from your .proto files.

3

Customize the layout

For a full list of configuration options and layout customizations, see Customize API Reference layout.

Include more than one gRPC Reference

To include multiple gRPC definitions in your documentation, use the api-name property. The api-name corresponds to the folder name containing your gRPC definition.

fern
fern.config.json
docs.yml
user-api
proto
user_service.proto# User gRPC service
generators.yml
billing-api
proto
billing_service.proto# Billing gRPC service
generators.yml
docs.yml
1navigation:
2 - api: User API
3 api-name: user-api
4 - api: Billing API
5 api-name: billing-api

Configuration properties

api.specs[].proto
Required

Path to your gRPC specification file. You can include multiple gRPC specs if your project exposes more than one API.