参考Ruby

生成 SDK

以 Markdown 格式查看

按照本页面的说明生成 Ruby SDK。

1

Install the Fern CLI

$npm install -g fern-api
2

Initialize the fern folder

Initialize the fern folder with your existing OpenAPI specification, or start from scratch with a Fern Definition template. Specify your organization name using the --organization flag.

$fern init --openapi path/to/openapi.yml \
>--organization <YourOrganization>

OpenAPI accepts both JSON and YAML formats. You can always convert a Fern Definition to OpenAPI or OpenAPI to a Fern Definition later on.

This creates a fern folder in your current directory.

fern
fern.config.json# root-level configuration
api# your API
generators.yml# generators you're using
openapi
openapi.yml# API-level configuration
3

Validate your API definition

Check that your API definition is valid, and fix errors before proceeding:

$fern check

添加 SDK 生成器

运行以下命令将 Ruby SDK 生成器添加到 generators.yml：

$fern add fern-ruby-sdk --group {{GROUP_NAME}}

此命令将以下 group 添加到 generators.yml：

generators.yml
1  ruby-sdk: # group name
2    generators:
3      - name: fernapi/fern-ruby-sdk
4        version: 1.11.1
5        output:
6          location: local-file-system
7          path: ../sdks/ruby

生成 SDK

运行以下命令生成您的 SDK：

$fern generate --group ruby-sdk

如果您有多个 API，请使用 --api 标志 指定要生成的 API：

$fern generate --group ruby-sdk --api your-api-name

This creates a sdks folder in your current directory. The resulting folder structure looks like this:

fern# 由 fern init 创建
sdks# 由 fern generate --group ruby-sdk 创建
ruby
YourOrganization_api_client.gemspec
test
lib
YourOrganization_api_client
15

Set up GitHub repositories

Fern uses a multi-repo structure: your source repository contains the fern/ folder, and each SDK gets its own separate repository.

  1. Create a source repository for your fern/ folder if you don’t have one already (e.g., your-org/your-api-definitions).
  2. Create an SDK repository for your SDK (e.g., your-org/your-api-ruby-sdk).
  3. Install the Fern GitHub App on both repositories.
16

发布到 RubyGems

按照 发布到 RubyGems 指南配置您的 gem 并通过 GitHub Actions 设置自动发布。