Trait OpenApiGenerator 

pub trait OpenApiGenerator {
    // Required methods
    fn spec(&self) -> &OpenAPI;
    fn registry(&self) -> &SchemaRegistry;
    fn generate_header(&self) -> String;
    fn generate_models(&self) -> Result<String>;
    fn generate_routes(&self) -> Result<String>;

    // Provided methods
    fn generate_footer(&self) -> String { ... }
    fn generate(&self) -> Result<String> { ... }
    fn iter_paths<F>(&self, f: F) -> Result<()>
       where F: FnMut(&str, &str, &Operation) -> Result<()> { ... }
    fn iter_schemas<F>(&self, f: F) -> Result<()>
       where F: FnMut(&str, &Schema) -> Result<()> { ... }
    fn extract_request_body_type(&self, operation: &Operation) -> Option<String> { ... }
    fn extract_response_type(&self, operation: &Operation) -> String { ... }
    fn extract_type_from_schema_ref(
        &self,
        schema_ref: &ReferenceOr<Schema>,
    ) -> String { ... }
    fn format_type_name(&self, name: &str) -> String { ... }
    fn default_response_type(&self) -> String { ... }
    fn generate_operation_id(
        &self,
        path: &str,
        method: &str,
        operation: &Operation,
    ) -> String { ... }
}

Base trait for OpenAPI code generators to eliminate duplication across languages.

Implementors should override language-specific methods while leveraging shared default implementations for common patterns.

Required Methods

fn spec(&self) -> &OpenAPI

Get the OpenAPI specification

fn registry(&self) -> &SchemaRegistry

Get the schema registry for reference resolution

fn generate_header(&self) -> String

Generate the file header (imports, module declaration, etc.)

fn generate_models(&self) -> Result<String>

Generate data models/DTOs from OpenAPI components

fn generate_routes(&self) -> Result<String>

Generate route handlers from OpenAPI paths

Provided Methods

fn generate_footer(&self) -> String

Generate file footer (bootstrap, exports, etc.)

fn generate(&self) -> Result<String>

Orchestrate the full code generation pipeline

fn iter_paths<F>(&self, f: F) -> Result<()>

where F: FnMut(&str, &str, &Operation) -> Result<()>,

Iterate over all paths in the spec and apply a function to each operation

fn iter_schemas<F>(&self, f: F) -> Result<()>

where F: FnMut(&str, &Schema) -> Result<()>,

Iterate over all component schemas and apply a function to each

fn extract_request_body_type(&self, operation: &Operation) -> Option<String>

Extract request body type from operation (looks for application/json)

fn extract_response_type(&self, operation: &Operation) -> String

Extract response type from operation (looks for 200/201 responses)

fn extract_type_from_schema_ref( &self, schema_ref: &ReferenceOr<Schema>, ) -> String

Extract type name from a schema reference or inline schema

fn format_type_name(&self, name: &str) -> String

Format a type name according to language conventions (PascalCase by default)

fn default_response_type(&self) -> String

Return the language’s default response type (e.g., “dict[str, Any]”, “Record<string, unknown>”)

fn generate_operation_id( &self, path: &str, method: &str, operation: &Operation, ) -> String

Generate operation ID (function/method name) from operation and path

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl OpenApiGenerator for ElixirGenerator