Struct GeneratorConfig 

pub struct GeneratorConfig {
    pub output: String,
    pub layout: OutputLayout,
    pub split_by: Option<SplitBy>,
    pub base_url: Option<String>,
    pub no_jsdoc: Option<bool>,
    pub source_dir: String,
    pub scaffold: Option<Value>,
}

Configuration for a single generator.

Each entry in the generators map deserializes into this struct. All fields except output have sensible defaults so a minimal config only needs the output directory.

TypeScript-only fields

base_url, no_jsdoc, and source_dir only affect the TypeScript generators (node-client and react-swr-client). They are silently ignored by fastapi-server.

Scaffold

The scaffold field is an opaque JSON object forwarded to the generator. Each generator defines its own scaffold struct (e.g., package name, formatter, test runner, bundler). See the default config for available scaffold options.

Fields

output: String

Output directory for generated files. Required — the generator writes all files relative to this path. Created automatically if it doesn’t exist.

layout: OutputLayout

How files are organized on disk. Default: modular.

• bundled — single file containing all types, client, and SSE utilities
• modular — separate files per concern (types, client, sse, index)
• split — separate files per operation group (see split_by)

split_by: Option<SplitBy>

Only used when layout: split. Controls how operations are grouped into files.

• tag (default) — one file per OpenAPI tag
• operation — one file per operation
• route — one file per route prefix

base_url: Option<String>

Override the API base URL instead of reading it from the spec’s servers array. Only affects TypeScript generators. Useful when the spec doesn’t include a server or you need a different URL for development.

no_jsdoc: Option<bool>

Disable JSDoc comments on generated types and methods. Default: false. Only affects TypeScript generators.

source_dir: String

Subdirectory within output for generated source files. Default: "src". The scaffold’s tsconfig.json and tsdown.config.ts adapt automatically. Set to "" to place source files directly at the output root. Only affects TypeScript generators.

scaffold: Option<Value>

Opaque scaffold configuration forwarded to the generator. Each generator defines its own scaffold options:

TypeScript generators (node-client, react-swr-client):

• package_name — npm package name (default: derived from spec title)
• repository — repository URL for package.json
• existing_repo — skip all scaffold files, only emit source + root index
• formatter — "biome" or false to disable (default: "biome")
• test_runner — "vitest" or false to disable (default: "vitest")
• bundler — "tsdown" or false to disable (default: "tsdown")

Python generator (fastapi-server):

• package_name — Python package name for pyproject.toml
• formatter — "ruff" or false to disable (default: "ruff")
• test_runner — "pytest" or false to disable (default: "pytest")

All generators:

• extra_dev_dependencies — map of additional dev dependency names to version specs, merged into the generated devDependencies (npm) or [dependency-groups] dev (Python). Example: { "@testing-library/react": "^16.0" } for npm, { "factory-boy": ">=3.3" } for Python.

Set to false to explicitly disable all scaffolding. Omitting the field entirely also disables scaffolding.

Trait Implementations

impl Clone for GeneratorConfig

fn clone(&self) -> GeneratorConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GeneratorConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GeneratorConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GeneratorConfig

where GeneratorConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.