Struct SchemaRegistry 

pub struct SchemaRegistry { /* private fields */ }

Registry for collecting and deduplicating JSON schemas.

The SchemaRegistry tracks schemas by name and returns $ref references when a schema is already registered. This prevents schema duplication in OpenAPI documents.

Example

use fastapi_openapi::{SchemaRegistry, JsonSchema, Schema};

#[derive(JsonSchema)]
struct User {
    id: i64,
    name: String,
}

let registry = SchemaRegistry::new();

// First access registers the schema and returns a $ref
let schema1 = User::schema_with_registry(&registry);
assert!(matches!(schema1, Schema::Ref(_)));

// Second access returns the same $ref without re-registering
let schema2 = User::schema_with_registry(&registry);
assert!(matches!(schema2, Schema::Ref(_)));

// Export all collected schemas for components/schemas
let schemas = registry.into_schemas();
assert!(schemas.contains_key("User"));

Implementations

impl SchemaRegistry

pub fn new() -> Self

Create a new empty registry.

pub fn get_or_register<T: JsonSchema>(&self, name: &str) -> Schema

Get or register a schema by name.

If the schema is already registered, returns a $ref reference. Otherwise, generates the schema, registers it, and returns a $ref.

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

Register a schema directly by name.

Returns a $ref to the registered schema.

pub fn contains(&self, name: &str) -> bool

Check if a schema with the given name is already registered.

pub fn len(&self) -> usize

Get the number of registered schemas.

pub fn is_empty(&self) -> bool

Check if the registry is empty.

pub fn into_schemas(self) -> HashMap<String, Schema>

Consume the registry and return all collected schemas.

The returned map is suitable for use in components.schemas.

pub fn schemas(&self) -> HashMap<String, Schema>

Get a clone of all registered schemas without consuming the registry.

pub fn merge(&self, other: &SchemaRegistry)

Merge another registry’s schemas into this one.

If a schema with the same name exists in both, the existing one is kept.

Trait Implementations

impl Clone for SchemaRegistry

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaRegistry

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

Formats the value using the given formatter.

impl Default for SchemaRegistry

fn default() -> SchemaRegistry

Returns the “default value” for a type.