Swift 配置

以 Markdown 格式查看

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

generators.yml
1groups:
2 swift-sdk:
3 generators:
4 - name: fernapi/fern-swift-sdk
5 version: 0.34.1
6 config:
7 clientClassName: YourClientName
8 environmentEnumName: YourCustomEnvironment
9 moduleName: MyCustomModule
10 enableWireTests: false
11 nullableAsOptional: true
clientClassName
string

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

environmentEnumName
string

生成的环境枚举的名称。这允许您自定义定义 API 环境(如生产、预发布、开发)的枚举名称,并确保在 SDK 生成过程中保持命名的一致性。

moduleName
string

在客户端代码中使用的模块名称(例如,import MyCustomModule)。当提供此名称时,它将在库、产品和目标中一致使用。

enableWireTests
booleanDefaults to true

生成模拟服务器(线路)测试以验证 SDK 是否发送正确的 HTTP 请求并根据 API 规范正确处理响应。

nullableAsOptional
booleanDefaults to false

启用时,可空字段会被解码为 Swift 可选类型(T?),而不是 Nullable<T> 包装类型。这简化了类型处理,但失去了区分显式 null 值和缺失字段的能力。禁用时(默认),可空字段使用 Nullable<T> 包装类型,这保留了显式设置为 null 的字段和响应中缺失字段之间的区别。