Package springfox.documentation.schema.plugins

Class SchemaPluginsManager

  • @Component
public class SchemaPluginsManager
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      SchemaPluginsManager​(org.springframework.plugin.core.PluginRegistry<springfox.documentation.spi.schema.ModelPropertyBuilderPlugin,​springfox.documentation.spi.DocumentationType> propertyEnrichers, org.springframework.plugin.core.PluginRegistry<springfox.documentation.spi.schema.ModelBuilderPlugin,​springfox.documentation.spi.DocumentationType> modelEnrichers, org.springframework.plugin.core.PluginRegistry<springfox.documentation.spi.schema.ViewProviderPlugin,​springfox.documentation.spi.DocumentationType> viewProviders, org.springframework.plugin.core.PluginRegistry<springfox.documentation.spi.schema.SyntheticModelProviderPlugin,​springfox.documentation.spi.schema.contexts.ModelContext> syntheticModelProviders)  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.util.Set<com.fasterxml.classmate.ResolvedType> dependencies​(springfox.documentation.spi.schema.contexts.ModelContext context)  
      springfox.documentation.schema.Model model​(springfox.documentation.spi.schema.contexts.ModelContext context)
      Deprecated. 
      springfox.documentation.schema.ModelSpecification modelSpecification​(springfox.documentation.spi.schema.contexts.ModelContext context)  
      springfox.documentation.schema.ModelProperty property​(springfox.documentation.spi.schema.contexts.ModelPropertyContext context)
      Deprecated. 
      springfox.documentation.schema.PropertySpecification propertySpecification​(springfox.documentation.spi.schema.contexts.ModelPropertyContext modelPropertyContext)  
      java.util.Optional<springfox.documentation.schema.Model> syntheticModel​(springfox.documentation.spi.schema.contexts.ModelContext context)
      Deprecated. 
      java.util.Optional<springfox.documentation.schema.ModelSpecification> syntheticModelSpecification​(springfox.documentation.spi.schema.contexts.ModelContext context)  
      java.util.List<springfox.documentation.schema.ModelProperty> syntheticProperties​(springfox.documentation.spi.schema.contexts.ModelContext context)
      Deprecated. 
      java.util.List<springfox.documentation.schema.PropertySpecification> syntheticPropertySpecifications​(springfox.documentation.spi.schema.contexts.ModelContext context)  
      springfox.documentation.spi.schema.ViewProviderPlugin viewProvider​(springfox.documentation.spi.DocumentationType documentationType)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SchemaPluginsManager

        @Autowired
public SchemaPluginsManager​(@Qualifier("modelPropertyBuilderPluginRegistry")
                            org.springframework.plugin.core.PluginRegistry<springfox.documentation.spi.schema.ModelPropertyBuilderPlugin,​springfox.documentation.spi.DocumentationType> propertyEnrichers,
                            @Qualifier("modelBuilderPluginRegistry")
                            org.springframework.plugin.core.PluginRegistry<springfox.documentation.spi.schema.ModelBuilderPlugin,​springfox.documentation.spi.DocumentationType> modelEnrichers,
                            @Qualifier("viewProviderPluginRegistry")
                            org.springframework.plugin.core.PluginRegistry<springfox.documentation.spi.schema.ViewProviderPlugin,​springfox.documentation.spi.DocumentationType> viewProviders,
                            @Qualifier("syntheticModelProviderPluginRegistry")
                            org.springframework.plugin.core.PluginRegistry<springfox.documentation.spi.schema.SyntheticModelProviderPlugin,​springfox.documentation.spi.schema.contexts.ModelContext> syntheticModelProviders)

    • Method Detail

      • property

        @Deprecated
public springfox.documentation.schema.ModelProperty property​(springfox.documentation.spi.schema.contexts.ModelPropertyContext context)
        Deprecated.
        Use propertySpecification(ModelPropertyContext) instead
        Parameters:
        context - - property context
        Returns:
        the model property
        Since:
        3.0.0

      • model

        @Deprecated
public springfox.documentation.schema.Model model​(springfox.documentation.spi.schema.contexts.ModelContext context)
        Deprecated.
        Use modelSpecification(ModelContext) instead
        Parameters:
        context - - model context
        Returns:
        the model
        Since:
        3.0.0

      • viewProvider

        public springfox.documentation.spi.schema.ViewProviderPlugin viewProvider​(springfox.documentation.spi.DocumentationType documentationType)

      • syntheticModel

        @Deprecated
public java.util.Optional<springfox.documentation.schema.Model> syntheticModel​(springfox.documentation.spi.schema.contexts.ModelContext context)
        Deprecated.
        Use syntheticModelSpecification(ModelContext) instead
        Parameters:
        context - - model context
        Returns:
        the model
        Since:
        3.0.0

      • modelSpecification

        public springfox.documentation.schema.ModelSpecification modelSpecification​(springfox.documentation.spi.schema.contexts.ModelContext context)

      • syntheticModelSpecification

        public java.util.Optional<springfox.documentation.schema.ModelSpecification> syntheticModelSpecification​(springfox.documentation.spi.schema.contexts.ModelContext context)

      • syntheticProperties

        @Deprecated
public java.util.List<springfox.documentation.schema.ModelProperty> syntheticProperties​(springfox.documentation.spi.schema.contexts.ModelContext context)
        Deprecated.
        Use syntheticPropertySpecifications(ModelContext) instead
        Parameters:
        context - - model context
        Returns:
        the model
        Since:
        3.0.0

      • dependencies

        public java.util.Set<com.fasterxml.classmate.ResolvedType> dependencies​(springfox.documentation.spi.schema.contexts.ModelContext context)

      • syntheticPropertySpecifications

        public java.util.List<springfox.documentation.schema.PropertySpecification> syntheticPropertySpecifications​(springfox.documentation.spi.schema.contexts.ModelContext context)

      • propertySpecification

        public springfox.documentation.schema.PropertySpecification propertySpecification​(springfox.documentation.spi.schema.contexts.ModelPropertyContext modelPropertyContext)