Package com.github.victools.jsonschema.generator

Class SchemaGenerator

java.lang.Object

com.github.victools.jsonschema.generator.SchemaGenerator

public class SchemaGenerator
extends Object

Generator for JSON Schema definitions via reflection based analysis of a given class.

Constructor Summary

Constructors

Constructor	Description
SchemaGenerator(SchemaGeneratorConfig config)	Constructor.
SchemaGenerator(SchemaGeneratorConfig config, TypeContext context)	Constructor.

Method Summary

Modifier and Type	Method	Description
SchemaBuilder	buildMultipleSchemaDefinitions()	Create a SchemaBuilder instance for collecting schema references via createSchemaReference() until finalizing the generation via collectDefinitions().
com.fasterxml.jackson.databind.node.ObjectNode	generateSchema(Type mainTargetType, Type... typeParameters)	Generate a JsonNode containing the JSON Schema representation of the given type.
SchemaGeneratorConfig	getConfig()	Returns the SchemaGeneratorConfig associated with this SchemaGenerator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchemaGenerator

public SchemaGenerator(SchemaGeneratorConfig config)

Constructor.

Parameters:

config - configuration to be applied

SchemaGenerator

public SchemaGenerator(SchemaGeneratorConfig config,
                       TypeContext context)

Constructor.

Parameters:

config - configuration to be applied

context - type resolution/introspection context to be used during schema generations (across multiple schema generations)

Method Detail

generateSchema

public com.fasterxml.jackson.databind.node.ObjectNode generateSchema(Type mainTargetType,
                                                                     Type... typeParameters)

Generate a JsonNode containing the JSON Schema representation of the given type.

Parameters:

mainTargetType - type for which to generate the JSON Schema

typeParameters - optional type parameters (in case of the mainTargetType being a parameterised type)

Returns:

generated JSON Schema

buildMultipleSchemaDefinitions

public SchemaBuilder buildMultipleSchemaDefinitions()

Create a SchemaBuilder instance for collecting schema references via createSchemaReference() until finalizing the generation via collectDefinitions().
This is intended when you want to create a document that includes JSON Schema definitions but is not a JSON Schema itself, e.g. creating model descriptions for an OpenAPI definition.

Returns:

SchemaBuilder instance

See Also:

: adding a single type to the builder instance, : generate an listing the common schema definitions

getConfig

public SchemaGeneratorConfig getConfig()

Returns the SchemaGeneratorConfig associated with this SchemaGenerator.

Returns:

a SchemaGeneratorConfig instance