依赖其他 API
依赖其他 API
导入 API 定义以生成统一的 SDK
Fern 允许你将其他 API 导入到你的 API 中。
这在以下情况下通常很有用:
- 你想在你的 API 中重用另一个 API 的类型
- 你想将多个微服务的 API 组合成一个 SDK(类似于 AWS SDK)
注册依赖 API
第一步是注册你想要依赖的 API。为此,使用 register 命令:
依赖已注册的 API
要添加对另一个 API 的依赖,你必须添加一个 dependencies.yml 来声明你希望依赖的 API。
fern
fern.config.json
generators.yml
dependencies.yml
definition
api.yml
imdb.yml
你的 dependencies.yml 包含你希望依赖的所有 API 的列表:
dependencies.yml
接下来,你需要在 Fern 定义中创建一个文件夹来存放依赖。在文件夹内,创建一个特殊文件 __package__.yml,用于指定你想要添加的依赖和版本。
fern
fern.config.json
generators.yml
dependencies.yml
definition
api.yml
imdb.yml
my-folder
__package__.yml
__package__.yml
当你使用 fern generate 生成 SDK 时,__package__.yml 文件将被你所依赖的 API 有效替换。