SDK 设计

设置本地 SDK 预览

以 Markdown 格式查看

配置 SDK 后，您可以使用 --preview 标志在发布前本地测试生成的 SDK 代码。这允许您在开发过程中快速迭代 SDK：

$# 预览所有 SDK
$fern generate --preview
$
$# 预览特定语言的 SDK
$fern generate --group <language>-sdk --preview

--preview 将您的 SDK 代码生成到 fern 文件夹内的本地 .preview/ 文件夹中。不会有任何更改发布到包管理器或 GitHub。

--preview 会保留您添加到 SDK 的任何自定义代码。

使用示例

以下是如何预览 Python SDK 的示例。

1

生成器配置

generators.yml
1api: 
2  path: ./path/to/openapi.yml
3groups:
4  python-sdk:
5    generators:
6      - name: fernapi/fern-python-sdk
7        version: 5.9.1
8        output:
9          location: pypi
10          package-name: imdb
11          token: ${PYPI_TOKEN}
12        github:
13          repository: imdb/imdb-python
14        config:
15          client_class_name: imdb
2

调用 Fern CLI

$fern generate --group python-sdk --preview
3

预览您的 SDK

生成的文件夹结构将如下所示：

fern
fern.config.json
.preview
fern-python-sdk
...
generators.yml
openapi
openapi.yml