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 and Description
JavadocPropertyCustomizer(JavadocProvider javadocProvider, ObjectMapperProvider objectMapperProvider) Instantiates a new Javadoc property customizer.

Method Summary

Modifier and Type	Method and 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.
void	setJavadocDescription(Class<?> cls, List<Field> fields, List<PropertyDescriptor> clsProperties, io.swagger.v3.oas.models.media.Schema existingSchema, boolean isProcessedType) Sets javadoc description.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.v3.core.converter.ModelConverter

isOpenapi31

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

setJavadocDescription

public void setJavadocDescription(Class<?> cls,
                                  List<Field> fields,
                                  List<PropertyDescriptor> clsProperties,
                                  io.swagger.v3.oas.models.media.Schema existingSchema,
                                  boolean isProcessedType)

Sets javadoc description.

Parameters:

cls - the cls

fields - the fields

clsProperties - the bean properties of cls

existingSchema - the existing schema

isProcessedType - the is processed type