Package org.springdoc.openapi.javadoc

Class JavadocPropertyCustomizer

java.lang.Object

org.springdoc.openapi.javadoc.JavadocPropertyCustomizer

All Implemented Interfaces:

io.swagger.v3.core.converter.ModelConverter

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

The type Javadoc property customizer.

Author:

bnasslahsen

Constructor Summary

Constructors

Constructor	Description
JavadocPropertyCustomizer(JavadocProvider javadocProvider, ObjectMapperProvider objectMapperProvider)	Instantiates a new Javadoc property customizer.

Method Summary

Modifier and Type	Method	Description
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

JavadocPropertyCustomizer

public JavadocPropertyCustomizer(JavadocProvider javadocProvider,
                                 ObjectMapperProvider objectMapperProvider)

Instantiates a new Javadoc property customizer.

Parameters:

javadocProvider - the javadoc provider

objectMapperProvider - the object mapper provider

Method Detail

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