Struct SchemaGenerator 

pub struct SchemaGenerator;

Schema generator for creating JSON Schemas from Rust types

This is a stateless utility that wraps the Schemars library, providing a clean interface for schema generation.

Examples

use torrust_tracker_deployer_lib::infrastructure::schema::SchemaGenerator;
use torrust_tracker_deployer_lib::application::command_handlers::create::config::EnvironmentCreationConfig;

let schema_json = SchemaGenerator::generate::<EnvironmentCreationConfig>()?;

Implementations

impl SchemaGenerator

pub fn generate<T: JsonSchema>() -> Result<String, SchemaGenerationError>

Generates a JSON Schema for the given type

The type must implement JsonSchema from the Schemars library.

Type Parameters

• T - The type to generate a schema for (must implement JsonSchema)

Returns

• Ok(String) - The JSON Schema as a pretty-printed JSON string
• Err(SchemaGenerationError) - If serialization fails

Examples

use torrust_tracker_deployer_lib::infrastructure::schema::SchemaGenerator;
use torrust_tracker_deployer_lib::application::command_handlers::create::config::EnvironmentCreationConfig;

let schema = SchemaGenerator::generate::<EnvironmentCreationConfig>()?;
assert!(schema.contains("\"$schema\""));
assert!(schema.contains("\"environment\""));

Errors

Returns SchemaGenerationError::SerializationFailed if the schema cannot be serialized to JSON (this should be extremely rare).