Export
Modules
Class Methods
.find
.find(name)
Finds an export by name.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
name | Symbol | The export name. |
Returns
Class<Export::Base>, nil
See also
Example
ruby
Apiwork::Export.find(:openapi).find!
.find!(name)
Finds an export by name.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
name | Symbol | The export name. |
Returns
Class<Export::Base>
See also
Example
ruby
Apiwork::Export.find!(:openapi).generate
.generate(export_name, api_base_path, format: nil, key_format: nil, locale: nil, **options)
Generates an export for an API.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
export_name | Symbol | The registered export name. Built-in: :openapi, :typescript, :zod. | |
api_base_path | String | The API base path. | |
format | Symbol<:json, :yaml>, nil | nil | The output format. Hash exports only. |
key_format | Symbol<:camel, :kebab, :keep, :pascal, :underscore>, nil | nil | The key format. |
locale | Symbol, nil | nil | The locale for translations. |
options | Export-specific keyword arguments. |
Returns
String
See also
Example
ruby
Apiwork::Export.generate(:openapi, '/api/v1')
Apiwork::Export.generate(:openapi, '/api/v1', format: :yaml)
Apiwork::Export.generate(:typescript, '/api/v1', key_format: :camel).register
.register(klass)
Registers an export.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
klass | Class<Export::Base> | The export class with export_name set. |
See also
Example
ruby
Apiwork::Export.register(JSONSchemaExport)