Struct OpenApiSpec 

pub struct OpenApiSpec {
    pub openapi: String,
    pub info: Info,
    pub components: Components,
}

Complete OpenAPI 3.0 specification.

Fields

openapi: String

info: Info

components: Components

Implementations

impl OpenApiSpec

pub fn builder( title: impl Into<String>, version: impl Into<String>, ) -> OpenApiBuilder

Create a new builder.

pub fn to_json(&self) -> Result<String, Error>

Convert to JSON string.

Examples found in repository

examples/user_api.rs (line 142)

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 256)

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!");
}

Trait Implementations

impl Clone for OpenApiSpec

fn clone(&self) -> OpenApiSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenApiSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OpenApiSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.