Package org.springdoc.core.converters

Class AdditionalModelsConverter

java.lang.Object

org.springdoc.core.converters.AdditionalModelsConverter

All Implemented Interfaces:

io.swagger.v3.core.converter.ModelConverter

public class AdditionalModelsConverter
extends Object
implements io.swagger.v3.core.converter.ModelConverter

The type Additional models converter.

Author:

bnasslahsen

Constructor Summary

Constructors

Constructor	Description
AdditionalModelsConverter(ObjectMapperProvider springDocObjectMapper)	Instantiates a new Additional models converter.

Method Summary

Modifier and Type	Method	Description
static void	disableReplacement(Class clazz)	Disable replacement.
static Class	getParameterObjectReplacement(Class clazz)	Gets replacement.
static void	replaceParameterObjectWithClass(Class source, Class target)	Replace ParameterObject with class.
static void	replaceWithClass(Class source, Class target)	Replace with class.
static void	replaceWithSchema(Class source, io.swagger.v3.oas.models.media.Schema target)	Replace with schema.
io.swagger.v3.oas.models.media.Schema	resolve(io.swagger.v3.core.converter.AnnotatedType type, io.swagger.v3.core.converter.ModelConverterContext context, Iterator<io.swagger.v3.core.converter.ModelConverter> chain)	Resolve schema.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdditionalModelsConverter

public AdditionalModelsConverter(ObjectMapperProvider springDocObjectMapper)

Instantiates a new Additional models converter.

Parameters:

springDocObjectMapper - the spring doc object mapper

Method Detail

replaceWithClass

public static void replaceWithClass(Class source,
                                    Class target)

Replace with class.

Parameters:

source - the source

target - the target

replaceWithSchema

public static void replaceWithSchema(Class source,
                                     io.swagger.v3.oas.models.media.Schema target)

Replace with schema.

Parameters:

source - the source

target - the target

replaceParameterObjectWithClass

public static void replaceParameterObjectWithClass(Class source,
                                                   Class target)

Replace ParameterObject with class.

Parameters:

source - the source

target - the target

getParameterObjectReplacement

public static Class getParameterObjectReplacement(Class clazz)

Gets replacement.

Parameters:

clazz - the clazz

Returns:

the replacement

disableReplacement

public static void disableReplacement(Class clazz)

Disable replacement.

Parameters:

clazz - the clazz

resolve

public io.swagger.v3.oas.models.media.Schema resolve(io.swagger.v3.core.converter.AnnotatedType type,
                                                     io.swagger.v3.core.converter.ModelConverterContext context,
                                                     Iterator<io.swagger.v3.core.converter.ModelConverter> chain)

Resolve schema.

Specified by:

resolve in interface io.swagger.v3.core.converter.ModelConverter

Parameters:

type - the type

context - the context

chain - the chain

Returns:

the schema