项目结构

在使用 Fern 生成 SDK 之前，需要设置合适的 GitHub 仓库结构来存放 API 定义和 SDK 代码，使您和用户都能直观地访问、维护和更新代码。

仓库架构

Fern 推荐使用多仓库结构，包含：

• 源仓库 包含 API 定义和 SDK 生成配置
• SDK 仓库 为每个 SDK（TypeScript、Python、Go 等）分别创建仓库

这种分离结构允许您集中管理 API 定义，同时将每个 SDK 保存在独立的仓库中，便于独立版本控制和分发。

核心配置文件

源仓库包含一个 fern/ 文件夹，其中包含 API 定义和顶级 generators.yml 文件。

fern.config.json

fern.config.json 文件存储您的组织名称和 Fern CLI 版本。固定版本可以提供确定性的构建。

1
{
2
  "organization": "plant-catalog",
3
  "version": "5.7.5"
4
}

generators.yml

generators.yml 文件在 groups 部分配置 SDK 生成。对于 OpenAPI/AsyncAPI，您还必须在 api.specs 部分声明 API 规范位置。

1
# API 声明（OpenAPI/AsyncAPI 必需）
2
api:
3
  specs:
4
    - openapi: ./openapi/openapi.yml
5
6
# SDK 生成
7
groups:
8
  ts-sdk:
9
    generators:
10
      - name: fernapi/fern-typescript-sdk
11
        version: 3.69.0
12
        github:
13
          repository: your-organization/typescript-sdk-repo
14
15
  python-sdk:
16
    generators:
17
      - name: fernapi/fern-python-sdk
18
        version: 5.9.1
19
        github:
20
          repository: your-organization/python-sdk-repo

完整的配置选项请参见 generators.yml 参考页面。

API 定义文件

有关组织 API 定义文件和处理多个 API 的详细信息，请参见 项目结构（API 定义）。