入门

快速开始

Beta
以 Markdown 格式查看
抢先体验

CLI 生成器处于抢先体验阶段。联系我们开始使用。

本指南介绍从 OpenAPI 规范生成 CLI 并在本地运行。完成后，您将拥有一个编译好的二进制文件，它将每个 API 端点映射为子命令，并从规范中配置好身份验证、输出格式化和分页。

前提条件

  • Fern CLI v5.37.9 或更高版本（npm install -g fern-api）
  • Rust 工具链（稳定版）
  • 至少包含一个端点的 OpenAPI 3.x 规范

设置

1

初始化 Fern 项目

$mkdir my-api-config && cd my-api-config
$fern init --organization my-org

这将创建一个包含默认配置文件的 fern/ 目录。

2

添加 OpenAPI 规范

将规范放在 fern/openapi.yml（或在下一步中引用的任何路径）。规范必须包含至少一个路径，components 下声明的任何 securitySchemes 将成为 CLI 在运行时读取的凭据。

3

配置生成器

替换 fern/generators.yml 的内容：

fern/generators.yml
1api:
2  specs:
3    - openapi: openapi.yml
4default-group: cli
5groups:
6  cli:
7    generators:
8      - name: fern-cli-generator
9        version: 0.23.4
10        github:
11          repo: my-org/my-cli
12          mode: release
13        config:
14          binaryName: my-cli
4

生成 CLI

$fern generate --group cli

Fern 读取 OpenAPI 规范，运行 CLI 生成器，并将完整的 Rust 项目写入输出路径。

5

构建并运行

$cd ../my-cli
$cargo build
$./target/debug/my-cli --help

--help 输出显示完整的命令树：从 OpenAPI 标签派生的顶级命令、从各个操作派生的子命令，以及 completion 和 man 等内置工具。

6

自定义输出

  • 通过在 generators.yml 上叠加 overrides 和 overlays 来重命名命令、隐藏端点或修补元数据，无需分叉规范。
  • 通过在 api.specs 下列出多个规范，使用多规范合并发布一个驱动多个 API 的二进制文件。
  • 使用自定义命令添加不映射到端点的子命令 — 登录流程、配置助手、本地工具。