org.apache.juneau.jsonschema

Class JsonSchemaGenerator

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.BeanTraverseContext

org.apache.juneau.jsonschema.JsonSchemaGenerator

@ConfigurableContext
public class JsonSchemaGenerator
extends BeanTraverseContext

Generates JSON-schema metadata about POJOs.

Field Summary

Fields

Modifier and Type	Field and Description
static JsonSchemaGenerator	DEFAULT Default serializer, all default settings.
static String	JSONSCHEMA_addDescriptionsTo Configuration property: Add descriptions to types.
static String	JSONSCHEMA_addExamplesTo Configuration property: Add examples.
static String	JSONSCHEMA_allowNestedDescriptions Configuration property: Allow nested descriptions.
static String	JSONSCHEMA_allowNestedExamples Configuration property: Allow nested examples.
static String	JSONSCHEMA_beanDefMapper Configuration property: Bean schema definition mapper.
static String	JSONSCHEMA_defaultSchemas Configuration property: Default schemas.
static String	JSONSCHEMA_ignoreTypes Configuration property: Ignore types from schema definitions.
static String	JSONSCHEMA_useBeanDefs Configuration property: Use bean definitions.

Fields inherited from class org.apache.juneau.BeanTraverseContext

BEANTRAVERSE_detectRecursions, BEANTRAVERSE_ignoreRecursions, BEANTRAVERSE_initialDepth, BEANTRAVERSE_maxDepth

Fields inherited from class org.apache.juneau.BeanContext

BEAN_beanClassVisibility, BEAN_beanConstructorVisibility, BEAN_beanDictionary, BEAN_beanDictionary_add, BEAN_beanDictionary_remove, BEAN_beanFieldVisibility, BEAN_beanFilters, BEAN_beanFilters_add, BEAN_beanFilters_remove, BEAN_beanMapPutReturnsOldValue, BEAN_beanMethodVisibility, BEAN_beansRequireDefaultConstructor, BEAN_beansRequireSerializable, BEAN_beansRequireSettersForGetters, BEAN_beansRequireSomeProperties, BEAN_beanTypePropertyName, BEAN_bpi, BEAN_bpro, BEAN_bpwo, BEAN_bpx, BEAN_debug, BEAN_examples, BEAN_excludeProperties, BEAN_fluentSetters, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_locale, BEAN_mediaType, BEAN_notBeanClasses, BEAN_notBeanClasses_add, BEAN_notBeanClasses_remove, BEAN_notBeanPackages, BEAN_notBeanPackages_add, BEAN_notBeanPackages_remove, BEAN_pojoSwaps, BEAN_pojoSwaps_add, BEAN_pojoSwaps_remove, BEAN_propertyNamer, BEAN_sortProperties, BEAN_timeZone, BEAN_useEnumNames, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED

Constructor Summary

Constructors

Constructor and Description
JsonSchemaGenerator(PropertyStore ps) Constructor.

Method Summary

Modifier and Type	Method and Description
JsonSchemaGeneratorBuilder	builder() Creates a builder from this context object.
static JsonSchemaGeneratorBuilder	create() Instantiates a new clean-slate JsonSerializerBuilder object.
JsonSchemaGeneratorSession	createSession() Create a new bean session based on the properties defined on this context.
JsonSchemaGeneratorSession	createSession(BeanSessionArgs args) Create a new bean session based on the properties defined on this context combined with the specified runtime args.
protected Set<TypeCategory>	getAddDescriptionsTo() Configuration property: Add descriptions to types.
protected Set<TypeCategory>	getAddExamplesTo() Configuration property: Add examples.
protected BeanDefMapper	getBeanDefMapper() Configuration property: Bean schema definition mapper.
protected Map<String,ObjectMap>	getDefaultSchemas() Configuration property: Default schemas.
Set<Pattern>	getIgnoreTypes() Configuration property: Ignore types from schema definitions.
protected boolean	isAllowNestedDescriptions() Configuration property: Allow nested descriptions.
protected boolean	isAllowNestedExamples() Configuration property: Allow nested examples.
boolean	isIgnoredType(ClassMeta<?> cm) Returns true if the specified type is ignored.
protected boolean	isUseBeanDefs() Configuration property: Use bean definitions.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.

Methods inherited from class org.apache.juneau.BeanTraverseContext

getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions

Methods inherited from class org.apache.juneau.BeanContext

_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createDefaultSessionArgs, createSession, dumpCacheStats, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBpi, getBpi, getBpro, getBpro, getBpwo, getBpwo, getBpx, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getExamples, getImplClassConstructor, getImplClasses, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getTimeZone, hasSameCache, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isNotABean, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, object, resolveClassMeta, string

Methods inherited from class org.apache.juneau.Context

equals, getArrayProperty, getArrayProperty, getBooleanProperty, getCdlProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, getStringPropertyWithNone, hashCode, identityCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSONSCHEMA_addDescriptionsTo

public static final String JSONSCHEMA_addDescriptionsTo

Configuration property: Add descriptions to types.

Property:

• Name: "JsonSchemaGenerator.addDescriptionsTo.s"
• Data type: String
• Default: Empty string.
• Session property: false
• Methods:
  • JsonSchemaGeneratorBuilder.addDescriptionsTo(String)

Description:

Identifies which categories of types that descriptions should be automatically added to generated schemas.

The description is the result of calling ClassMeta.getFullName().

The format is a comma-delimited list of any of the following values:

• BEAN
• COLLECTION
• ARRAY
• MAP
• STRING
• NUMBER
• BOOLEAN
• ANY
• OTHER

See Also:

Constant Field Values

JSONSCHEMA_addExamplesTo

public static final String JSONSCHEMA_addExamplesTo

Configuration property: Add examples.

Property:

• Name: "JsonSchemaGenerator.addExamplesTo.s"
• Data type: String
• Default: Empty string.
• Session property: false
• Methods:
  • JsonSchemaGeneratorBuilder.addExamplesTo(String)

Description:

Identifies which categories of types that examples should be automatically added to generated schemas.

The examples come from calling ClassMeta.getExample(BeanSession) which in turn gets examples from the following:

• Example
• BeanContext.BEAN_examples

The format is a comma-delimited list of any of the following values:

• BEAN
• COLLECTION
• ARRAY
• MAP
• STRING
• NUMBER
• BOOLEAN
• ANY
• OTHER

See Also:

Constant Field Values

JSONSCHEMA_allowNestedDescriptions

public static final String JSONSCHEMA_allowNestedDescriptions

Configuration property: Allow nested descriptions.

Property:

• Name: "JsonSchemaGenerator.allowNestedDescriptions.b"
• Data type: Boolean
• Default: false
• Session property: false
• Methods:
  • JsonSchemaGeneratorBuilder.allowNestedDescriptions()

Description:

Identifies whether nested descriptions are allowed in schema definitions.

See Also:

Constant Field Values

JSONSCHEMA_allowNestedExamples

public static final String JSONSCHEMA_allowNestedExamples

Configuration property: Allow nested examples.

Property:

• Name: "JsonSchemaGenerator.allowNestedExamples.b"
• Data type: Boolean
• Default: false
• Session property: false
• Methods:
  • JsonSchemaGeneratorBuilder.allowNestedExamples()

Description:

Identifies whether nested examples are allowed in schema definitions.

See Also:

Constant Field Values

JSONSCHEMA_beanDefMapper

public static final String JSONSCHEMA_beanDefMapper

Configuration property: Bean schema definition mapper.

Property:

• Name: "JsonSchemaGenerator.beanDefMapper.o"
• Data type: BeanDefMapper
• Default: BasicBeanDefMapper
• Session property: false
• Methods:
  • JsonSchemaGeneratorBuilder.beanDefMapper(Class)
  • JsonSchemaGeneratorBuilder.beanDefMapper(BeanDefMapper)

Description:

Interface to use for converting Bean classes to definition IDs and URIs.

Used primarily for defining common definition sections for beans in Swagger JSON.

This setting is ignored if JSONSCHEMA_useBeanDefs is not enabled.

See Also:

Constant Field Values

JSONSCHEMA_defaultSchemas

public static final String JSONSCHEMA_defaultSchemas

Configuration property: Default schemas.

Property:

• Name: "JsonSchemaGenerator.defaultSchema.smo"
• Data type: Map<String,ObjectMap>
• Default: Empty map.
• Session property: false
• Methods:
  • JsonSchemaGeneratorBuilder.defaultSchema(Class,ObjectMap)

Description:

Allows you to override or provide custom schema information for particular class types.

Keys are full class names.

See Also:

Constant Field Values

JSONSCHEMA_ignoreTypes

public static final String JSONSCHEMA_ignoreTypes

Configuration property: Ignore types from schema definitions.

Property:

• Name: "JsonSchemaGenerator.ignoreTypes.s"
• Data type: String (comma-delimited)
• Default: null.
• Session property: false

Description:

Defines class name patterns that should be ignored when generating schema definitions in the generated Swagger documentation.

Example:

// Don't generate schema for any prototype packages or the class named 'Swagger'. @Rest( properties={ @Property(name=JSONSCHEMA_ignoreTypes, value="Swagger,*.proto.*") } public class MyResource {...}

See Also:

Constant Field Values

JSONSCHEMA_useBeanDefs

public static final String JSONSCHEMA_useBeanDefs

Configuration property: Use bean definitions.

Property:

• Name: "JsonSchemaGenerator.useBeanDefs.b"
• Data type: Boolean
• Default: false
• Methods:
  • JsonSchemaGeneratorBuilder.useBeanDefs()

Description:

When enabled, schemas on beans will be serialized as the following:

{ type: 'object', '$ref': '#/definitions/TypeId' }

The definitions can then be retrieved from the session using JsonSchemaGeneratorSession.getBeanDefs().

Definitions can also be added programmatically using JsonSchemaGeneratorSession.addBeanDef(String, ObjectMap).

See Also:

Constant Field Values

DEFAULT

public static final JsonSchemaGenerator DEFAULT

Default serializer, all default settings.

Constructor Detail

JsonSchemaGenerator

public JsonSchemaGenerator(PropertyStore ps)

Constructor.

Parameters:

ps - Initialize with the specified config property store.

Method Detail

builder

public JsonSchemaGeneratorBuilder builder()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

builder in class BeanTraverseContext

Returns:

A new ContextBuilder object.

create

public static JsonSchemaGeneratorBuilder create()

Instantiates a new clean-slate JsonSerializerBuilder object.

This is equivalent to simply calling new JsonSerializerBuilder().

Returns:

A new JsonSerializerBuilder object.

createSession

public JsonSchemaGeneratorSession createSession()

Description copied from class: BeanContext

Create a new bean session based on the properties defined on this context.

Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.

Overrides:

createSession in class BeanTraverseContext

Returns:

A new session object.

createSession

public JsonSchemaGeneratorSession createSession(BeanSessionArgs args)

Description copied from class: BeanContext

Create a new bean session based on the properties defined on this context combined with the specified runtime args.

Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.

Overrides:

createSession in class BeanTraverseContext

Parameters:

args - The session arguments.

Returns:

A new session object.

getAddDescriptionsTo

protected final Set<TypeCategory> getAddDescriptionsTo()

Configuration property: Add descriptions to types.

Returns:

Set of categories of types that descriptions should be automatically added to generated schemas.

See Also:

JSONSCHEMA_addDescriptionsTo

getAddExamplesTo

protected final Set<TypeCategory> getAddExamplesTo()

Configuration property: Add examples.

Returns:

Set of categories of types that examples should be automatically added to generated schemas.

See Also:

JSONSCHEMA_addExamplesTo

isAllowNestedDescriptions

protected final boolean isAllowNestedDescriptions()

Configuration property: Allow nested descriptions.

Returns:

true if nested descriptions are allowed in schema definitions.

See Also:

JSONSCHEMA_allowNestedDescriptions

isAllowNestedExamples

protected final boolean isAllowNestedExamples()

Configuration property: Allow nested examples.

Returns:

true if nested examples are allowed in schema definitions.

See Also:

JSONSCHEMA_allowNestedExamples

getBeanDefMapper

protected final BeanDefMapper getBeanDefMapper()

Configuration property: Bean schema definition mapper.

Returns:

Interface to use for converting Bean classes to definition IDs and URIs.

See Also:

JSONSCHEMA_beanDefMapper

getDefaultSchemas

protected final Map<String,ObjectMap> getDefaultSchemas()

Configuration property: Default schemas.

Returns:

Custom schema information for particular class types.

See Also:

JSONSCHEMA_defaultSchemas

getIgnoreTypes

public Set<Pattern> getIgnoreTypes()

Configuration property: Ignore types from schema definitions.

Returns:

Custom schema information for particular class types.

See Also:

JSONSCHEMA_ignoreTypes

isUseBeanDefs

protected final boolean isUseBeanDefs()

Configuration property: Use bean definitions.

Returns:

true if schemas on beans will be serialized with '$ref' tags.

See Also:

JSONSCHEMA_useBeanDefs

isIgnoredType

public boolean isIgnoredType(ClassMeta<?> cm)

Returns true if the specified type is ignored.

The type is ignored if it's specified in the JSONSCHEMA_ignoreTypes setting.
Ignored types return null on the call to JsonSchemaGeneratorSession.getSchema(ClassMeta).

Parameters:

cm - The type to check.

Returns:

true if the specified type is ignored.

toMap

public ObjectMap toMap()

Description copied from class: Context

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

toMap in class BeanTraverseContext

Returns:

A new map containing the properties defined on this context.