Struct SchemaGenerator 

pub struct SchemaGenerator { /* private fields */ }

Available on crate feature openapi and non-WebAssembly only.

Schema generator for OpenAPI schemas

This is a builder for creating OpenAPI 3.0 schemas with support for:

• Schema registry for component reuse
• Advanced enum handling
• Serde attributes integration

Example

use reinhardt_rest::openapi::generator::SchemaGenerator;
use reinhardt_rest::openapi::{Schema, SchemaExt};

let mut generator = SchemaGenerator::new()
    .title("My API")
    .version("1.0.0")
    .description("API documentation");

// Register schemas
generator.registry().register("User", Schema::object_with_properties(
    vec![
        ("id", Schema::integer()),
        ("name", Schema::string()),
    ],
    vec!["id", "name"],
));

// Generate OpenAPI schema
let schema = generator.generate().unwrap();

Implementations

impl SchemaGenerator

pub fn new() -> SchemaGenerator

Available on crate feature rest only.

Create a new schema generator

Example

use reinhardt_rest::openapi::generator::SchemaGenerator;

let generator = SchemaGenerator::new();

pub fn title(self, title: impl Into<String>) -> SchemaGenerator

Available on crate feature rest only.

Set the API title

Example

use reinhardt_rest::openapi::generator::SchemaGenerator;

let generator = SchemaGenerator::new()
    .title("My API");

pub fn version(self, version: impl Into<String>) -> SchemaGenerator

Available on crate feature rest only.

Set the API version

Example

use reinhardt_rest::openapi::generator::SchemaGenerator;

let generator = SchemaGenerator::new()
    .version("2.0.0");

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

Available on crate feature rest only.

Set the API description

Example

use reinhardt_rest::openapi::generator::SchemaGenerator;

let generator = SchemaGenerator::new()
    .description("My awesome API");

pub fn registry(&mut self) -> &mut SchemaRegistry

Available on crate feature rest only.

Get a reference to the schema registry

Example

use reinhardt_rest::openapi::generator::SchemaGenerator;
use reinhardt_rest::openapi::{Schema, SchemaExt};

let mut generator = SchemaGenerator::new();
generator.registry().register("User", Schema::object());

assert!(generator.registry().contains("User"));

pub fn get_registry(&self) -> &SchemaRegistry

Available on crate feature rest only.

Get the schema registry

Example

use reinhardt_rest::openapi::generator::SchemaGenerator;

let generator = SchemaGenerator::new();
let registry = generator.get_registry();
assert!(registry.is_empty());

pub fn add_function_based_endpoints(self) -> SchemaGenerator

Available on crate feature rest only.

Add function-based endpoints from HTTP method decorators

This method uses the EndpointInspector to collect endpoint metadata from the global inventory and adds them to the OpenAPI schema as paths.

Example

use reinhardt_rest::openapi::generator::SchemaGenerator;

let generator = SchemaGenerator::new()
    .title("My API")
    .version("1.0.0")
    .add_function_based_endpoints();

// All endpoints decorated with #[get], #[post], etc. are now included
let schema = generator.generate().unwrap();

pub fn add_server_fn<S>(self, _marker: S) -> SchemaGenerator

Available on crate feature rest and non-crate feature pages only.

Add a single server function endpoint (no-op when pages feature is disabled)

pub fn generate(&self) -> Result<OpenApi, SchemaError>

Available on crate feature rest only.

Generate the OpenAPI schema

This generates an OpenAPI 3.0 schema with all registered components.

Example

use reinhardt_rest::openapi::generator::SchemaGenerator;
use reinhardt_rest::openapi::{Schema, SchemaExt};

let mut generator = SchemaGenerator::new()
    .title("My API")
    .version("1.0.0");

generator.registry().register("User", Schema::object());

let schema = generator.generate().unwrap();
assert_eq!(schema.info.title, "My API");

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

Available on crate feature rest only.

Generate OpenAPI schema as JSON string

Example

use reinhardt_rest::openapi::generator::SchemaGenerator;

let generator = SchemaGenerator::new()
    .title("My API")
    .version("1.0.0");

let json = generator.to_json().unwrap();
assert!(json.contains("\"title\": \"My API\""));

pub fn to_yaml(&self) -> Result<String, SchemaError>

Available on crate feature rest only.

Generate OpenAPI schema as YAML string

Example

use reinhardt_rest::openapi::generator::SchemaGenerator;

let generator = SchemaGenerator::new()
    .title("My API")
    .version("1.0.0");

let yaml = generator.to_yaml().unwrap();
assert!(yaml.contains("title: My API"));

Trait Implementations

impl Default for SchemaGenerator

fn default() -> SchemaGenerator

Returns the “default value” for a type.