Package org.sdase.commons.shared.asyncapi.jsonschema.victools

Class VictoolsJsonSchemaBuilder

java.lang.Object

org.sdase.commons.shared.asyncapi.jsonschema.victools.VictoolsJsonSchemaBuilder

All Implemented Interfaces:

JsonSchemaBuilder

public class VictoolsJsonSchemaBuilder
extends Object
implements JsonSchemaBuilder

A JsonSchemaBuilder that uses victools/json-schema-generator to build Json Schemas from Java code.

Constructor Summary

Constructors

Constructor	Description
VictoolsJsonSchemaBuilder(com.github.victools.jsonschema.generator.SchemaGeneratorConfig schemaGeneratorConfig)	A VictoolsJsonSchemaBuilder with custom configuration.

Method Summary

Modifier and Type	Method	Description
static VictoolsJsonSchemaBuilder	fromDefaultConfig()
Map<String,com.fasterxml.jackson.databind.JsonNode>	toJsonSchema(Type type)	Creates Json Schema (in version Draft 07 as required by AsyncAPI) for the given type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sdase.commons.shared.asyncapi.jsonschema.JsonSchemaBuilder

toJsonSchema

Constructor Details

VictoolsJsonSchemaBuilder

public VictoolsJsonSchemaBuilder(com.github.victools.jsonschema.generator.SchemaGeneratorConfig schemaGeneratorConfig)

A VictoolsJsonSchemaBuilder with custom configuration.

Parameters:

schemaGeneratorConfig - the configuration

Method Details

fromDefaultConfig

public static VictoolsJsonSchemaBuilder fromDefaultConfig()

Returns:

a JsonSchemaBuilder generating schemas suitable for AsyncAPI.

toJsonSchema

public Map<String,com.fasterxml.jackson.databind.JsonNode> toJsonSchema(Type type)

Description copied from interface: JsonSchemaBuilder

Creates Json Schema (in version Draft 07 as required by AsyncAPI) for the given type.

Specified by:

toJsonSchema in interface JsonSchemaBuilder

Parameters:

type - the java type, usually a Class, for which the Json Schema should be created.

Returns:

A Map with the Json Schemas of all types needed to describe the given type. The key of the map qualifies as definition key as used in /components/schemas/<key> for the respective Json Schema. One key exactly matches the Class.getSimpleName() of the given type and refers to the Json Schema of that type. All references to other generated schemas in the returned map are qualified as $ref: "#/components/messages/<map-entry-key> when referenced.

See Also:

• Adapting the references, when using the generated schemas in another documentation structure.