Struct Generator

pub struct Generator { /* private fields */ }

Implementations

impl Generator

pub fn new(openapi: OpenAPI, default_options: GeneratorOptions) -> Self

Creates a new instance of Generator.

Arguments

• openapi - An instance of the OpenAPI structure representing the OpenAPI specification.
• default_options - An instance of GeneratorOptions to configure the generator’s behavior.

Returns

A new Generator instance initialized with the provided OpenAPI specification and generator options.

Examples

use openapiv3::OpenAPI;
use openapiv3_to_typescript::{Generator, GeneratorOptions};

let openapi = OpenAPI::default();
let options = GeneratorOptions::default();
let generator = Generator::new(openapi, options);

pub fn generate_schema<'a>( &'a self, schema: &'a Schema, options: Option<GeneratorOptions>, ) -> PartialGeneration<'a>

Generates a TypeScript type definition from an OpenAPI schema.

Arguments

• schema - A reference to the Schema object from the OpenAPI specification that you want to generate the TypeScript type for.
• options - An optional instance of GeneratorOptions to override the default options for this generation.

Returns

A PartialGeneration instance containing the generated TypeScript type definition as a string and a vector of references that were included in the generation process.

Examples

use openapiv3::{OpenAPI, Schema};
use openapiv3_to_typescript::{Generator, GeneratorOptions, PartialGeneration};

let openapi = OpenAPI::default();
let options = GeneratorOptions { skip_read_only: true };
let generator = Generator::new(openapi, options);
let schema = Schema::new_number();
let partial_generation: PartialGeneration = generator.generate_schema(&schema, None);

println!("{:?}", partial_generation);

pub fn generate_path( &self, operation_id: String, ) -> Option<PartialGeneration<'_>>

pub fn openapi(&self) -> &OpenAPI

Trait Implementations

impl Debug for Generator

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

Formats the value using the given formatter.