gRPC generators.yml 参考 | Fern Documentation

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

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

generators.yml

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

stringRequired

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

string

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

string | list of strings

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

1 # 单个重写文件
2 overrides: ./overrides.yml
3 
4 # 多个重写文件（按顺序应用）
5 overrides:
6   - ./base-overrides.yml
7   - ./sdk-overrides.yml

booleanDefaults to false

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