Package org.springdoc.core.utils

Class SchemaUtils

java.lang.Object

org.springdoc.core.utils.SchemaUtils

public class SchemaUtils
extends Object

The type Validation utils.

Author:

dyun

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	ANNOTATIONS_FOR_REQUIRED	The constant ANNOTATIONS_FOR_REQUIRED.
static final Boolean	JAVA_FIELD_NULLABLE_DEFAULT	The constant JAVA_FIELD_NULLABLE_DEFAULT.

Method Summary

Modifier and Type	Method	Description
static boolean	annotatedNotNull(List<Annotation> annotations)	Is annotated notnull.
static void	applyValidationsToSchema(io.swagger.v3.oas.models.media.Schema<?> schema, List<Annotation> annotations)	Apply validations to schema. the annotation order effects the result of the validation.
static boolean	fieldNullable(Field field)	Is field nullable. java default is nullable JAVA_FIELD_NULLABLE_DEFAULT
static boolean	fieldRequired(Field field, io.swagger.v3.oas.annotations.media.Schema schema, io.swagger.v3.oas.annotations.Parameter parameter)	Is field required.
static boolean	hasNotNullAnnotation(Collection<String> annotationSimpleNames)	Check if the parameter has any of the annotations that make it non-optional
static Boolean	swaggerRequired(io.swagger.v3.oas.annotations.media.Schema schema, io.swagger.v3.oas.annotations.Parameter parameter)	Is swagger required. it may return null if not specified require value or mode
static boolean	swaggerVisible(io.swagger.v3.oas.annotations.media.Schema schema, io.swagger.v3.oas.annotations.Parameter parameter)	Is swagger visible.

Methods inherited from class java.lang.Object

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

Field Details

JAVA_FIELD_NULLABLE_DEFAULT

public static final Boolean JAVA_FIELD_NULLABLE_DEFAULT

The constant JAVA_FIELD_NULLABLE_DEFAULT.

ANNOTATIONS_FOR_REQUIRED

public static final List<String> ANNOTATIONS_FOR_REQUIRED

The constant ANNOTATIONS_FOR_REQUIRED.

Method Details

swaggerVisible

public static boolean swaggerVisible(@Nullable
 io.swagger.v3.oas.annotations.media.Schema schema,
 @Nullable
 io.swagger.v3.oas.annotations.Parameter parameter)

Is swagger visible.

Parameters:

schema - the schema

parameter - the parameter

Returns:

the boolean

swaggerRequired

@Nullable
public static Boolean swaggerRequired(@Nullable
 io.swagger.v3.oas.annotations.media.Schema schema,
 @Nullable
 io.swagger.v3.oas.annotations.Parameter parameter)

Is swagger required. it may return null if not specified require value or mode

Parameters:

schema - the schema

parameter - the parameter

Returns:

the boolean or null

See Also:

• Parameter.required()
• Schema.required()
• Schema.requiredMode()

hasNotNullAnnotation

public static boolean hasNotNullAnnotation(Collection<String> annotationSimpleNames)

Check if the parameter has any of the annotations that make it non-optional

Parameters:

annotationSimpleNames - the annotation simple class named, e.g. NotNull

Returns:

whether any of the known NotNull annotations are present

annotatedNotNull

public static boolean annotatedNotNull(List<Annotation> annotations)

Is annotated notnull.

Parameters:

annotations - the field annotations

Returns:

the boolean

fieldNullable

public static boolean fieldNullable(Field field)

Is field nullable. java default is nullable JAVA_FIELD_NULLABLE_DEFAULT

Parameters:

field - the field

Returns:

the boolean

fieldRequired

public static boolean fieldRequired(Field field,
 @Nullable
 io.swagger.v3.oas.annotations.media.Schema schema,
 @Nullable
 io.swagger.v3.oas.annotations.Parameter parameter)

Is field required.

Parameters:

field - the field

schema - the schema

parameter - the parameter

Returns:

the boolean

See Also:

• Parameter.required()
• Schema.required()
• Schema.requiredMode()

applyValidationsToSchema

public static void applyValidationsToSchema(io.swagger.v3.oas.models.media.Schema<?> schema,
 List<Annotation> annotations)

Apply validations to schema. the annotation order effects the result of the validation.

Parameters:

schema - the schema

annotations - the annotations