Rust 配置 | Fern Documentation

您可以在 generators.yml 中自定义 Rust SDK 生成器的行为：

generators.yml

1 groups:
2   rust-sdk:
3     generators:
4       - name: fernapi/fern-rust-sdk
5         version: 0.35.0
6         config:
7           clientClassName: YourClientName
8           crateName: your-crate-name
9           crateVersion: "1.0.0"
10           dateTimeType: "offset"
11           environmentEnumName: YourEnvironment
12           enableWireTests: true

clientClassName

string

生成的客户端结构体的名称。这允许您自定义用户在使用您的 SDK 时将实例化的结构体名称。

crateName

string

生成的 Rust crate 的名称。这在 Cargo.toml 中使用，并决定用户如何将您的 SDK 添加为依赖项。

crateVersion

string

生成的 crate 的版本。这在 Cargo.toml 中使用，用于发布到 crates.io。

dateTimeType

'offset' | 'utc'Defaults to offset

确定如何处理时区信息：

offset：使用 DateTime<FixedOffset> 来保留 API 响应中的原始时区
utc：使用 DateTime<Utc> 将所有日期时间标准化为 UTC，无论其原始时区如何

两个选项都接受任何日期时间格式，如果日期时间字符串中没有提供时区，则假定为 UTC。

environmentEnumName

string

生成的环境枚举的名称。这允许您自定义定义 API 环境（如生产、预发布、开发）的枚举名称。

enableWebsockets

booleanDefaults to false

启用时，为具有 WebSocket 通道的 API 生成 WebSocket 客户端代码。WebSocket 通道可通过根客户端的连接器结构体访问（例如 client.realtime.connect(...)）。

enableWireTests

booleanDefaults to false

启用时，生成模拟服务器（wire）测试来验证 SDK 是否发送正确的 HTTP 请求并按照 API 规范正确处理响应。

generateExamples

booleanDefaults to true

启用时，在 README 和参考文档中生成代码示例。

包元数据

配置发布到 crates.io 的元数据：

generators.yml

1 config:
2   packageDescription: "SDK for the Plant Store API"
3   packageLicense: "MIT"
4   packageRepository: "https://github.com/your-org/your-sdk"
5   packageDocumentation: "https://docs.example.com"

packageDescription

string

crates.io 上 crate 的描述。这会出现在 crate 的元数据和搜索结果中。

packageLicense

string

crate 的许可证标识符（例如 “MIT”、“Apache-2.0”）。

packageLicenseFile

string

自定义许可证文件的路径（例如 LICENSE.md）。设置时，在 Cargo.toml 中使用 license-file 而不是 license。当您的许可证不是标准的软件包数据交换（SPDX）标识符时，这很有用。

packageRepository

string

crate 源代码仓库的 URL。

packageDocumentation

string

crate 文档的 URL。

依赖项

为生成的 SDK 添加自定义依赖项：

generators.yml

1 config:
2   extraDependencies:
3     tokio: "1.0"
4     serde_json: "1.0"
5   extraDevDependencies:
6     mockall: "0.11"

extraDependencies

object

要包含在生成的 Cargo.toml 中的额外依赖项。指定为 crate 名称到版本要求的映射。您还可以指定具有功能和默认功能的完整依赖项规范：

generators.yml

1 config:
2   extraDependencies:
3     reqwest:
4       version: "0.12"
5       defaultFeatures: true

generators.yml

1 config:
2   extraDependencies:
3     reqwest:
4       version: "0.12"
5       features: ["rustls-tls"]

extraDevDependencies

object

要包含在生成的 Cargo.toml 中的额外开发依赖项。这些仅在开发和测试期间使用。