Struct OpenApiBuilder 

pub struct OpenApiBuilder { /* private fields */ }

Builder for OpenAPI specifications.

Implementations

impl OpenApiBuilder

pub fn new(title: impl Into<String>, version: impl Into<String>) -> Self

Create a new OpenAPI builder.

Example

use domainstack_schema::OpenApiBuilder;

let spec = OpenApiBuilder::new("My API", "1.0.0")
    .description("A sample API")
    .build();

Examples found in repository

examples/user_api.rs (line 134)

fn main() {
    // Build OpenAPI specification
    let spec = OpenApiBuilder::new("User Management API", "1.0.0")
        .description("API for managing users, addresses, and teams with validation")
        .register::<User>()
        .register::<Address>()
        .register::<Team>()
        .build();

    // Output as JSON
    let json = spec.to_json().expect("Failed to serialize to JSON");
    println!("{}", json);

    println!("\n=== Schema Generation Complete ===");
    println!("Registered schemas:");
    println!("  - User (with email, age, name, status)");
    println!("  - Address (with street, zip code, city)");
    println!("  - Team (with name and members array)");
    println!("\nValidation constraints mapped to OpenAPI:");
    println!("  [ok] email → format: email");
    println!("  [ok] range(min, max) → minimum, maximum");
    println!("  [ok] length(min, max) → minLength, maxLength");
    println!("  [ok] one_of → enum");
    println!("  [ok] min_items, max_items → minItems, maxItems");
    println!("  [ok] numeric_string → pattern: ^[0-9]+$");
}

examples/v08_features.rs (line 245)

fn main() {
    let spec = OpenApiBuilder::new("v0.8 Features Demo", "1.0.0")
        .description("Demonstrates OpenAPI v0.8 features: composition, metadata, and extensions")
        .register::<PaymentMethod>()
        .register::<AdminUser>()
        .register::<User>()
        .register::<UserSettings>()
        .register::<UserAccount>()
        .register::<DateRange>()
        .register::<OrderForm>()
        .build();

    println!("{}", spec.to_json().expect("Failed to serialize"));

    println!("\n=== v0.8 Features Demonstrated ===");
    println!("[ok] anyOf: PaymentMethod (union of card | cash)");
    println!("[ok] allOf: AdminUser (extends User)");
    println!("[ok] default: UserSettings.theme = 'auto'");
    println!("[ok] example: UserSettings.theme example = 'dark'");
    println!("[ok] examples: UserSettings.language examples = ['en', 'es', 'fr']");
    println!("[ok] readOnly: UserAccount.id, createdAt (response only)");
    println!("[ok] writeOnly: UserAccount.password (request only)");
    println!("[ok] deprecated: UserAccount.oldUsername");
    println!("[ok] vendor extensions: DateRange, OrderForm (x-domainstack-validations)");
    println!("\nAll v0.8 features working correctly!");
}

pub fn description(self, desc: impl Into<String>) -> Self

Set the API description.

Examples found in repository

examples/user_api.rs (line 135)

fn main() {
    // Build OpenAPI specification
    let spec = OpenApiBuilder::new("User Management API", "1.0.0")
        .description("API for managing users, addresses, and teams with validation")
        .register::<User>()
        .register::<Address>()
        .register::<Team>()
        .build();

    // Output as JSON
    let json = spec.to_json().expect("Failed to serialize to JSON");
    println!("{}", json);

    println!("\n=== Schema Generation Complete ===");
    println!("Registered schemas:");
    println!("  - User (with email, age, name, status)");
    println!("  - Address (with street, zip code, city)");
    println!("  - Team (with name and members array)");
    println!("\nValidation constraints mapped to OpenAPI:");
    println!("  [ok] email → format: email");
    println!("  [ok] range(min, max) → minimum, maximum");
    println!("  [ok] length(min, max) → minLength, maxLength");
    println!("  [ok] one_of → enum");
    println!("  [ok] min_items, max_items → minItems, maxItems");
    println!("  [ok] numeric_string → pattern: ^[0-9]+$");
}

examples/v08_features.rs (line 246)

fn main() {
    let spec = OpenApiBuilder::new("v0.8 Features Demo", "1.0.0")
        .description("Demonstrates OpenAPI v0.8 features: composition, metadata, and extensions")
        .register::<PaymentMethod>()
        .register::<AdminUser>()
        .register::<User>()
        .register::<UserSettings>()
        .register::<UserAccount>()
        .register::<DateRange>()
        .register::<OrderForm>()
        .build();

    println!("{}", spec.to_json().expect("Failed to serialize"));

    println!("\n=== v0.8 Features Demonstrated ===");
    println!("[ok] anyOf: PaymentMethod (union of card | cash)");
    println!("[ok] allOf: AdminUser (extends User)");
    println!("[ok] default: UserSettings.theme = 'auto'");
    println!("[ok] example: UserSettings.theme example = 'dark'");
    println!("[ok] examples: UserSettings.language examples = ['en', 'es', 'fr']");
    println!("[ok] readOnly: UserAccount.id, createdAt (response only)");
    println!("[ok] writeOnly: UserAccount.password (request only)");
    println!("[ok] deprecated: UserAccount.oldUsername");
    println!("[ok] vendor extensions: DateRange, OrderForm (x-domainstack-validations)");
    println!("\nAll v0.8 features working correctly!");
}

pub fn register<T: ToSchema>(self) -> Self

Register a type that implements ToSchema.

Example

use domainstack_schema::{OpenApiBuilder, ToSchema, Schema};

struct User;
impl ToSchema for User {
    fn schema_name() -> &'static str { "User" }
    fn schema() -> Schema { Schema::object() }
}

let spec = OpenApiBuilder::new("API", "1.0")
    .register::<User>()
    .build();

Examples found in repository

examples/user_api.rs (line 136)

fn main() {
    // Build OpenAPI specification
    let spec = OpenApiBuilder::new("User Management API", "1.0.0")
        .description("API for managing users, addresses, and teams with validation")
        .register::<User>()
        .register::<Address>()
        .register::<Team>()
        .build();

    // Output as JSON
    let json = spec.to_json().expect("Failed to serialize to JSON");
    println!("{}", json);

    println!("\n=== Schema Generation Complete ===");
    println!("Registered schemas:");
    println!("  - User (with email, age, name, status)");
    println!("  - Address (with street, zip code, city)");
    println!("  - Team (with name and members array)");
    println!("\nValidation constraints mapped to OpenAPI:");
    println!("  [ok] email → format: email");
    println!("  [ok] range(min, max) → minimum, maximum");
    println!("  [ok] length(min, max) → minLength, maxLength");
    println!("  [ok] one_of → enum");
    println!("  [ok] min_items, max_items → minItems, maxItems");
    println!("  [ok] numeric_string → pattern: ^[0-9]+$");
}

examples/v08_features.rs (line 247)

fn main() {
    let spec = OpenApiBuilder::new("v0.8 Features Demo", "1.0.0")
        .description("Demonstrates OpenAPI v0.8 features: composition, metadata, and extensions")
        .register::<PaymentMethod>()
        .register::<AdminUser>()
        .register::<User>()
        .register::<UserSettings>()
        .register::<UserAccount>()
        .register::<DateRange>()
        .register::<OrderForm>()
        .build();

    println!("{}", spec.to_json().expect("Failed to serialize"));

    println!("\n=== v0.8 Features Demonstrated ===");
    println!("[ok] anyOf: PaymentMethod (union of card | cash)");
    println!("[ok] allOf: AdminUser (extends User)");
    println!("[ok] default: UserSettings.theme = 'auto'");
    println!("[ok] example: UserSettings.theme example = 'dark'");
    println!("[ok] examples: UserSettings.language examples = ['en', 'es', 'fr']");
    println!("[ok] readOnly: UserAccount.id, createdAt (response only)");
    println!("[ok] writeOnly: UserAccount.password (request only)");
    println!("[ok] deprecated: UserAccount.oldUsername");
    println!("[ok] vendor extensions: DateRange, OrderForm (x-domainstack-validations)");
    println!("\nAll v0.8 features working correctly!");
}

pub fn schema(self, name: impl Into<String>, schema: Schema) -> Self

Manually add a schema with a custom name.

pub fn build(self) -> OpenApiSpec

Build the final OpenAPI specification.

Examples found in repository

examples/user_api.rs (line 139)

fn main() {
    // Build OpenAPI specification
    let spec = OpenApiBuilder::new("User Management API", "1.0.0")
        .description("API for managing users, addresses, and teams with validation")
        .register::<User>()
        .register::<Address>()
        .register::<Team>()
        .build();

    // Output as JSON
    let json = spec.to_json().expect("Failed to serialize to JSON");
    println!("{}", json);

    println!("\n=== Schema Generation Complete ===");
    println!("Registered schemas:");
    println!("  - User (with email, age, name, status)");
    println!("  - Address (with street, zip code, city)");
    println!("  - Team (with name and members array)");
    println!("\nValidation constraints mapped to OpenAPI:");
    println!("  [ok] email → format: email");
    println!("  [ok] range(min, max) → minimum, maximum");
    println!("  [ok] length(min, max) → minLength, maxLength");
    println!("  [ok] one_of → enum");
    println!("  [ok] min_items, max_items → minItems, maxItems");
    println!("  [ok] numeric_string → pattern: ^[0-9]+$");
}

examples/v08_features.rs (line 254)

fn main() {
    let spec = OpenApiBuilder::new("v0.8 Features Demo", "1.0.0")
        .description("Demonstrates OpenAPI v0.8 features: composition, metadata, and extensions")
        .register::<PaymentMethod>()
        .register::<AdminUser>()
        .register::<User>()
        .register::<UserSettings>()
        .register::<UserAccount>()
        .register::<DateRange>()
        .register::<OrderForm>()
        .build();

    println!("{}", spec.to_json().expect("Failed to serialize"));

    println!("\n=== v0.8 Features Demonstrated ===");
    println!("[ok] anyOf: PaymentMethod (union of card | cash)");
    println!("[ok] allOf: AdminUser (extends User)");
    println!("[ok] default: UserSettings.theme = 'auto'");
    println!("[ok] example: UserSettings.theme example = 'dark'");
    println!("[ok] examples: UserSettings.language examples = ['en', 'es', 'fr']");
    println!("[ok] readOnly: UserAccount.id, createdAt (response only)");
    println!("[ok] writeOnly: UserAccount.password (request only)");
    println!("[ok] deprecated: UserAccount.oldUsername");
    println!("[ok] vendor extensions: DateRange, OrderForm (x-domainstack-validations)");
    println!("\nAll v0.8 features working correctly!");
}