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.
预约演示登录免费开始
  • 概览
    • 什么是 API 定义?
    • 项目结构
      • 概览
      • 覆盖(Overrides)
      • 身份验证
      • 服务器
      • 同步您的规范
      • gRPC generators.yml 参考
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
预约演示登录免费开始
在本页
  • root
  • target
  • overrides
  • local-generation
gRPC

gRPC generators.yml 参考

||以 Markdown 格式查看|
此页面是否有帮助?
在仪表板中编辑
上一个

错误处理

下一个

什么是 Fern Definition?

generators.yml 文件有两个作用:它声明你的 gRPC 规范位置(在 api.specs 部分),并配置 SDK 生成(在可选的 groups 部分)。

在此声明的 API 可以通过 docs.yml 在你的文档中渲染。请参阅 生成你的 API 参考。

generators.yml
1api:
2 specs:
3 - proto:
4 root: "./proto"
5 target: "proto/service/v1/service.proto"
6 local-generation: true
root
stringRequired

到 .proto 目录根目录的路径(例如 proto)。必须指定到包开始的位置。例如,如果您的包是 package.test.v1,文件路径为 protos/package/test/v1/test_file.proto,那么根目录应该是 protos/

target
string

到目标 .proto 文件的路径(例如 proto/user/v1/user.proto)。省略此参数将为整个根文件夹生成文档。

overrides
string | list of strings

重写配置文件的路径,或者按顺序应用的多个重写文件的路径列表。仅用于 SDK 生成,不用于文档生成。

1# 单个重写文件
2overrides: ./overrides.yml
3
4# 多个重写文件(按顺序应用)
5overrides:
6 - ./base-overrides.yml
7 - ./sdk-overrides.yml
local-generation
booleanDefaults to false

是否在本地编译 .proto 文件。默认使用远程生成(false)。启用时,您必须在您的机器上或在您的 CI/CD 环境(例如 GitHub Actions) 中安装 buf。