参考Go

生成 SDK

以 Markdown 格式查看

按照本页面的说明生成 Go SDK。

1

Install the Fern CLI

$npm install -g fern-api
2

Initialize the fern folder

Initialize the fern folder with your existing OpenAPI specification. Specify your organization name using the --organization flag.

$fern init --openapi path/to/openapi.yml \
>--organization <YourOrganization>

OpenAPI accepts both JSON and YAML formats.

This creates a fern folder in your current directory.

fern
fern.config.json# root-level configuration
generators.yml# generators and API spec configuration
3

Validate your API definition

Check that your API definition is valid, and fix errors before proceeding:

$fern check
4

添加 SDK 生成器

运行以下命令将 Go SDK 生成器添加到 generators.yml：

$fern add fern-go-sdk --group {{GROUP_NAME}}

此命令将以下 group 添加到 generators.yml：

generators.yml
1  go-sdk: # 组名称
2    generators:
3      - name: fern-go-sdk
4        version: 1.46.0
5        output:
6          location: local-file-system
7          path: ../sdks/go
5

生成 SDK

运行以下命令生成您的 SDK：

$fern generate --group go-sdk

如果您有多个 API，请使用 --api 标志指定要生成的 API：

$fern generate --group go-sdk --api your-api-name

The first time you run fern generate, you must log in. Confirm the prompt and choose any of the login methods to authenticate, then generation continues automatically.

fern generate creates a sdks folder in your current directory. The resulting folder structure looks like this:

fern# 由 fern init 创建
sdks# 由 fern generate --group go-sdk 创建
go
core
go.mod
6

Set up GitHub repositories

Fern uses a multi-repo structure: your source repository contains the fern/ folder, and each SDK gets its own separate repository.

  1. Create a source repository for your fern/ folder if you don’t have one already (e.g., your-org/your-api-definitions).
  2. Create an SDK repository for your SDK (e.g., your-org/your-api-go-sdk).
  3. Install the Fern GitHub App on both repositories.
7

发布为 Go 模块

按照发布为 Go 模块指南配置您的模块并通过 GitHub Actions 设置自动发布。