添加自定义代码

以 Markdown 格式查看

Fern 生成的 SDK 设计为可使用自定义逻辑、方法和依赖项进行扩展。如果您希望您的 SDK 不仅仅进行基本的 API 调用(比如组合多个调用、处理数据、添加工具类),您可以添加与生成代码和谐共存的自定义代码。

您还可以通过继承 Fern 生成的客户端并扩展它来添加自定义方法,并在您的 generators.yml 文件中添加您的自定义方法依赖的任何依赖项。

使用 .fernignore 保留您的自定义代码

一旦您添加了包含自定义代码的文件,使用 .fernignore 来保护您的自定义代码不被 Fern 重新生成 SDK 时覆盖。

只需将您的自定义文件添加到 SDK 仓库并在 .fernignore 中列出它们。Fern 不会覆盖其中列出的任何文件。当您使用 GitHub 发布时,会在您的 SDK 仓库中自动创建一个 .fernignore 文件。

.fernignore 仅适用于 SDK 生成。它对 Fern Docs 构建没有影响。

您的 .fernignore 文件可能看起来像这样:

.fernignore
1# Documentation and licensing
2README.md
3LICENSE
4
5# Custom workflows
6.github/workflows/test.yml
7.github/workflows/ci.yml
8
9# Custom code
10src/CustomClient.ts
有关另一个示例,请参阅 Cohere 的 TypeScript SDK 的 .fernignore 文件

您的每个 SDK 都将有一个单独的 .fernignore 文件:

company-repo# 所有 SDK 的顶级仓库
fern
typescript-sdk-repo# TypeScript SDK 的仓库
.fernignore
.github
src
python-sdk-repo
.fernignore
.github
src

使用自定义代码增强您的 SDK

开始为特定 SDK 添加自定义代码: