添加自定义代码（Go） | Fern Documentation

本页面介绍如何为你的 Go SDK 添加自定义逻辑和方法。

These steps cover adding a new custom file to the SDK. To preserve line-level edits to a generated file, use Replay instead.

添加自定义逻辑

开始添加自定义代码：

创建新文件并添加自定义逻辑

helper.go

func MyHelper() {
  fmt.Println("Hello World!")
}

将文件添加到 `.fernignore`

.fernignore

# Specify files that shouldn't be modified by Fern
helper.go

使用辅助函数

Now your users can consume the helper function by importing it from the SDK.

import "github.com/package/example"
example.MyHelper();

添加自定义 SDK 方法

Fern also allows you to add custom methods to the SDK itself (e.g. client.my_method() ) by inheriting the Fern generated client and then extending it.

更新 `generators.yml` 配置

将你的 Fern 生成的客户端命名为 BaseClient 之类的名称，以反映该客户端将被扩展。

generators.yml

- name: fern-go-sdk
    version: "..."
    config:
      clientName: BaseClient

导入并扩展生成的客户端

首先，导入 Fern 生成的基础客户端并对其进行扩展。然后，添加你想要的任何方法。

client/my_client.go

type MyClient struct {
  *Client // Embed the Fern generated client.
}
func NewMyClient(opts ...option.RequestOption) *MyClient {
  return &MyClient{
    Client: NewClient(opts...),
  }
}
func (m *MyClient) MyHelper() {
  fmt.Println("Hello World!")
}

更新 `.fernignore`

将 client/my_client.go 添加到 .fernignore。

.fernignore

+ client/my_client.go

使用方法

你的用户不需要构造生成的客户端，而是构造扩展的客户端。

main.go

import exampleclient "github.com/package/example/client"
client := exampleclient.NewMyClient():