Package org.springdoc.core

Class SpringDocUtils

  • public class SpringDocUtils
extends Object
    The type Spring doc utils.
    Author:
    bnasslahsen

    • Method Detail

      • getConfig

        public static SpringDocUtils getConfig()
        Gets config.
        Returns:
        the config

      • addDeprecatedType

        public SpringDocUtils addDeprecatedType​(Class<? extends Annotation> cls)
        Add deprecated type spring doc utils.
        Parameters:
        cls - the cls
        Returns:
        the spring doc utils

      • addRestControllers

        public SpringDocUtils addRestControllers​(Class<?>... classes)
        Add rest controllers spring doc utils.
        Parameters:
        classes - the classes
        Returns:
        the spring doc utils

      • addHiddenRestControllers

        public SpringDocUtils addHiddenRestControllers​(Class<?>... classes)
        Add hidden rest controllers spring doc utils.
        Parameters:
        classes - the classes
        Returns:
        the spring doc utils

      • addHiddenRestControllers

        public SpringDocUtils addHiddenRestControllers​(String... classes)
        Add hidden rest controllers spring doc utils.
        Parameters:
        classes - the classes
        Returns:
        the spring doc utils

      • replaceWithClass

        public SpringDocUtils replaceWithClass​(Class source,
                                       Class target)
        Replace with class spring doc utils.
        Parameters:
        source - the source
        target - the target
        Returns:
        the spring doc utils

      • replaceWithSchema

        public SpringDocUtils replaceWithSchema​(Class source,
                                        io.swagger.v3.oas.models.media.Schema target)
        Replace with schema spring doc utils.
        Parameters:
        source - the source
        target - the target
        Returns:
        the spring doc utils

      • addRequestWrapperToIgnore

        public SpringDocUtils addRequestWrapperToIgnore​(Class<?>... classes)
        Add request wrapper to ignore spring doc utils.
        Parameters:
        classes - the classes
        Returns:
        the spring doc utils

      • removeRequestWrapperToIgnore

        public SpringDocUtils removeRequestWrapperToIgnore​(Class<?>... classes)
        Remove request wrapper to ignore spring doc utils.
        Parameters:
        classes - the classes
        Returns:
        the spring doc utils

      • addFileType

        public SpringDocUtils addFileType​(Class<?>... classes)
        Add file type spring doc utils.
        Parameters:
        classes - the classes
        Returns:
        the spring doc utils

      • addResponseWrapperToIgnore

        public SpringDocUtils addResponseWrapperToIgnore​(Class<?> cls)
        Add response wrapper to ignore spring doc utils.
        Parameters:
        cls - the cls
        Returns:
        the spring doc utils

      • removeResponseWrapperToIgnore

        public SpringDocUtils removeResponseWrapperToIgnore​(Class<?> cls)
        Remove response wrapper to ignore spring doc utils.
        Parameters:
        cls - the cls
        Returns:
        the spring doc utils

      • addResponseTypeToIgnore

        public SpringDocUtils addResponseTypeToIgnore​(Class<?> cls)
        Add response type to ignore spring doc utils.
        Parameters:
        cls - the cls
        Returns:
        the spring doc utils

      • removeResponseTypeToIgnore

        public SpringDocUtils removeResponseTypeToIgnore​(Class<?> cls)
        Remove response type to ignore spring doc utils.
        Parameters:
        cls - the cls
        Returns:
        the spring doc utils

      • addAnnotationsToIgnore

        public SpringDocUtils addAnnotationsToIgnore​(Class<?>... classes)
        Add annotations to ignore spring doc utils.
        Parameters:
        classes - the classes
        Returns:
        the spring doc utils

      • removeAnnotationsToIgnore

        public SpringDocUtils removeAnnotationsToIgnore​(Class<?>... classes)
        Remove annotations to ignore spring doc utils.
        Parameters:
        classes - the classes
        Returns:
        the spring doc utils

      • addFluxWrapperToIgnore

        public SpringDocUtils addFluxWrapperToIgnore​(Class<?> cls)
        Add flux wrapper to ignore spring doc utils.
        Parameters:
        cls - the cls
        Returns:
        the spring doc utils

      • removeFluxWrapperToIgnore

        public SpringDocUtils removeFluxWrapperToIgnore​(Class<?> cls)
        Remove flux wrapper to ignore spring doc utils.
        Parameters:
        cls - the cls
        Returns:
        the spring doc utils

      • addSimpleTypesForParameterObject

        public SpringDocUtils addSimpleTypesForParameterObject​(Class<?>... classes)
        Add simple types for parameter object spring doc utils.
        Parameters:
        classes - the classes
        Returns:
        the spring doc utils

      • removeSimpleTypesForParameterObject

        public SpringDocUtils removeSimpleTypesForParameterObject​(Class<?>... classes)
        Remove simple types for parameter object spring doc utils.
        Parameters:
        classes - the classes
        Returns:
        the spring doc utils

      • addSimpleTypePredicateForParameterObject

        public SpringDocUtils addSimpleTypePredicateForParameterObject​(Predicate<Class<?>> predicate)
        Add simple type predicate for parameter object spring doc utils.
        Parameters:
        predicate - the predicate
        Returns:
        the spring doc utils

      • disableReplacement

        public SpringDocUtils disableReplacement​(Class source)
        Disable replacement spring doc utils.
        Parameters:
        source - the source
        Returns:
        the spring doc utils

      • replaceParameterObjectWithClass

        public SpringDocUtils replaceParameterObjectWithClass​(Class source,
                                                      Class target)
        Replace the ParameterObject with the target class.
        Parameters:
        source - the source
        target - the target
        Returns:
        the spring doc utils

      • setResponseEntityExceptionHandlerClass

        public SpringDocUtils setResponseEntityExceptionHandlerClass​(Class<?> clazz)
        Sets response entity exception handler class.
        Parameters:
        clazz - the clazz
        Returns:
        the response entity exception handler class

      • setModelAndViewClass

        public SpringDocUtils setModelAndViewClass​(Class<?> clazz)
        Sets model and view class.
        Parameters:
        clazz - the clazz
        Returns:
        the model and view class