Adding custom code

Create a new file and add your custom logic

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

Add your file to .fernignore

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

Consume the helper

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

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

Update generators.yml configuration

Name your Fern-generated client something like BaseClient to reflect that this client will be extended.

1
- name: fernapi/fern-go-sdk
2
    version: "..."
3
    config:
4
      clientName: BaseClient

Import and extend the generated client

First, import the Fern generated base client and extend it. Then, add whatever methods you want.

1
type MyClient struct {
2
  *Client // Embed the Fern generated client.
3
}
4
5
func NewMyClient(opts ...option.RequestOption) *MyClient {
6
  return &MyClient{
7
    Client: NewClient(opts...),
8
  }
9
}
10
11
func (m *MyClient) MyHelper() {
12
  fmt.Println("Hello World!")
13
}

Update .fernignore

Add the client/my_client.go. to .fernignore.

1
+ client/my_client.go

Consume the method

Instead of constructing the generated client, your users will want to construct the extended client.

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

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

1
client.MyHelper()