预览与发布Generation

生成 gRPC API 参考文档

以 Markdown 格式查看

Fern 从您的协议缓冲区（.proto）文件生成 gRPC API 参考文档。将您的 .proto 文件添加到 Fern 项目中，Fern 将服务、RPC、消息和类型渲染为交互式参考文档。

配置

1

设置项目结构

将您的 .proto 文件添加到 /fern 目录，并创建引用它们的 generators.yml：

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

将 gRPC 参考添加到导航中

在 docs.yml 的导航中添加 - api: API Reference：

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

Fern 将自动从您的 .proto 文件填充服务、RPC、消息类型和枚举。

3

自定义布局

有关配置选项和布局自定义的完整列表，请参阅自定义 API 参考布局。

包含多个 gRPC 参考

要在文档中包含多个 gRPC 定义，请使用 api-name 属性。api-name 对应包含您的 gRPC 定义的文件夹名称。

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

配置属性

api.specs[].proto
Required

您的 gRPC 规范文件的路径。如果您的项目公开多个 API，您可以包含多个 gRPC 规范。