GeneratorsRuby

Ruby Configuration

You can customize the behavior of the Ruby SDK generator in generators.yml:

1default-group: local
2groups:
3  local:
4    generators:
5      - name: fernapi/fern-ruby
6        version: 1.0.0-rc0
7        config:
8          clientClassName: YourClientName

SDK Configuration Options

clientClassName
string

The name of the generated client class. This allows you to customize the class name that users will instantiate when using your SDK.

defaultTimeoutInSeconds
number | 'infinity'

The default timeout for network requests in seconds. In the generated client, this can be overridden at the request level. Set to ‘infinity’ to disable timeouts.

extraDependencies
ExtraDependenciesSchema

Specify additional dependencies to include in the generated SDK’s gemspec. This is useful when you need to add custom gems that your SDK depends on.

extraDevDependencies
ExtraDependenciesSchema

Specify additional development dependencies to include in the generated SDK’s gemspec. These are dependencies used for development and testing but not required by end users.

flattenModuleStructure
booleanDefaults to false

When enabled, flattens the module structure of the generated SDK. This creates a simpler namespace hierarchy by reducing nested modules.

useProvidedDefaults
boolean

When enabled, the SDK will use default values specified in your API definition. This allows you to leverage defaults defined in your Fern specification within the generated Ruby client.