设置本地 SDK 预览

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

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

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

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

使用示例

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

生成器配置

generators.yml

1 api: 
2   path: ./path/to/openapi.yml
3 groups:
4   python-sdk:
5     generators:
6       - name: fernapi/fern-python-sdk
7         version: 5.10.0
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

调用 Fern CLI

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

预览您的 SDK

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

fern

fern.config.json

.preview

fern-python-sdk

...

generators.yml

openapi

openapi.yml

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

1	api:
2	path: ./path/to/openapi.yml
3	groups:
4	python-sdk:
5	generators:
6	- name: fernapi/fern-python-sdk
7	version: 5.10.0
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