> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://buildwithfern.com/learn/llms.txt.

# Generate gRPC API Reference

> Use Fern Docs to generate gRPC API Reference documentation from Protocol Buffer (.proto) files.

Fern generates gRPC API Reference documentation from your [Protocol Buffer (`.proto`) files](/learn/api-definitions/grpc/overview). Add your `.proto` files to your Fern project and Fern renders services, RPCs, messages, and types as an interactive reference.

## Configuration

#### Set up your project structure

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

**`generators.yml`**

```yaml generators.yml
api:
  specs:
    - proto:
        root: ./proto
        target: proto/service/v1/service.proto
```

#### Add the gRPC Reference to your navigation

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

**`docs.yml`**

```yml docs.yml
navigation:
  - api: API Reference
```

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

#### Customize the layout

For a full list of configuration options and layout customizations, see [Customize API Reference layout](/learn/docs/api-references/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.

**`docs.yml`**

```yaml title="docs.yml"
navigation:
  - api: User API
    api-name: user-api
  - api: Billing API
    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.

---

> Use Fern Docs to generate gRPC API Reference documentation from Protocol Buffer (.proto) files.