Struct schemars::gen::SchemaGenerator

source · [−]

pub struct SchemaGenerator { /* private fields */ }

Expand description

The main type used to generate JSON Schemas.

Example

use schemars::{JsonSchema, gen::SchemaGenerator};

#[derive(JsonSchema)]
struct MyStruct {
    foo: i32,
}

let gen = SchemaGenerator::default();
let schema = gen.into_root_schema_for::<MyStruct>();

Implementations

source

impl SchemaGenerator

source

pub fn new(settings: SchemaSettings) -> SchemaGenerator

Creates a new SchemaGenerator using the given settings.

source

pub fn settings(&self) -> &SchemaSettings

Borrows the SchemaSettings being used by this SchemaGenerator.

pub fn make_extensible(&self, schema: &mut SchemaObject)

Modifies the given SchemaObject so that it may have validation, metadata or other properties set on it.

If schema is not a $ref schema, then this does not modify schema. Otherwise, depending on this generator’s settings, this may wrap the $ref in another schema. This is required because in many JSON Schema implementations, a schema with $ref set may not include other properties.

Example

use schemars::{gen::SchemaGenerator, schema::SchemaObject};

let gen = SchemaGenerator::default();

let ref_schema = SchemaObject::new_ref("foo".to_owned());
assert!(ref_schema.is_ref());

let mut extensible_schema = ref_schema.clone();
gen.make_extensible(&mut extensible_schema);
assert_ne!(ref_schema, extensible_schema);
assert!(!extensible_schema.is_ref());

let mut extensible_schema2 = extensible_schema.clone();
gen.make_extensible(&mut extensible_schema);
assert_eq!(extensible_schema, extensible_schema2);

source

pub fn schema_for_any(&self) -> Schema

Returns a Schema that matches everything, such as the empty schema {}.

The exact value returned depends on this generator’s BoolSchemas setting.

source

pub fn schema_for_none(&self) -> Schema

Returns a Schema that matches nothing, such as the schema { "not":{} }.

The exact value returned depends on this generator’s BoolSchemas setting.

source

pub fn subschema_for<T: ?Sized + JsonSchema>(&mut self) -> Schema

Generates a JSON Schema for the type T, and returns either the schema itself or a $ref schema referencing T’s schema.

If T is referenceable, this will add T’s schema to this generator’s definitions, and return a $ref schema referencing that schema. Otherwise, this method behaves identically to JsonSchema::json_schema.

If T’s schema depends on any referenceable schemas, then this method will add them to the SchemaGenerator’s schema definitions.

source

pub fn definitions(&self) -> &Map<String, Schema>

Returns the collection of all referenceable schemas that have been generated.

The keys of the returned Map are the schema names, and the values are the schemas themselves.

source

pub fn into_definitions(self) -> Map<String, Schema>

Consumes self and returns the collection of all referenceable schemas that have been generated.

The keys of the returned Map are the schema names, and the values are the schemas themselves.

source

pub fn root_schema_for<T: ?Sized + JsonSchema>(&mut self) -> RootSchema

Generates a root JSON Schema for the type T.

If T’s schema depends on any referenceable schemas, then this method will add them to the SchemaGenerator’s schema definitions and include them in the returned SchemaObject’s definitions

source

pub fn into_root_schema_for<T: ?Sized + JsonSchema>(self) -> RootSchema

Consumes self and generates a root JSON Schema for the type T.

If T’s schema depends on any referenceable schemas, then this method will include them in the returned SchemaObject’s definitions

source

pub fn dereference<'a>(&'a self, schema: &Schema) -> Option<&'a Schema>

Attemps to find the schema that the given schema is referencing.

If the given schema has a $ref property which refers to another schema in self’s schema definitions, the referenced schema will be returned. Otherwise, returns None.

Example

use schemars::{JsonSchema, gen::SchemaGenerator};

#[derive(JsonSchema)]
struct MyStruct {
    foo: i32,
}

let mut gen = SchemaGenerator::default();
let ref_schema = gen.subschema_for::<MyStruct>();

assert!(ref_schema.is_ref());

let dereferenced = gen.dereference(&ref_schema);

assert!(dereferenced.is_some());
assert!(!dereferenced.unwrap().is_ref());
assert_eq!(dereferenced, gen.definitions().get("MyStruct"));