Package springfox.documentation.schema.plugins

Class SchemaPluginsManager

java.lang.Object

springfox.documentation.schema.plugins.SchemaPluginsManager

@Component
public class SchemaPluginsManager
extends java.lang.Object

Constructor Summary

Constructors

Constructor

Description

SchemaPluginsManager(org.springframework.plugin.core.PluginRegistry<ModelPropertyBuilderPlugin,DocumentationType> propertyEnrichers, org.springframework.plugin.core.PluginRegistry<ModelBuilderPlugin,DocumentationType> modelEnrichers, org.springframework.plugin.core.PluginRegistry<ViewProviderPlugin,DocumentationType> viewProviders, org.springframework.plugin.core.PluginRegistry<SyntheticModelProviderPlugin,ModelContext> syntheticModelProviders)

Method Summary

Modifier and Type	Method	Description
java.util.Set<com.fasterxml.classmate.ResolvedType>	dependencies(ModelContext context)
Model	model(ModelContext context)	Deprecated.
ModelSpecification	modelSpecification(ModelContext context)
ModelProperty	property(ModelPropertyContext context)	Deprecated.
PropertySpecification	propertySpecification(ModelPropertyContext modelPropertyContext)
java.util.Optional<Model>	syntheticModel(ModelContext context)	Deprecated.
java.util.Optional<ModelSpecification>	syntheticModelSpecification(ModelContext context)
java.util.List<ModelProperty>	syntheticProperties(ModelContext context)	Deprecated.
java.util.List<PropertySpecification>	syntheticPropertySpecifications(ModelContext context)
ViewProviderPlugin	viewProvider(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<ModelPropertyBuilderPlugin,DocumentationType> propertyEnrichers,
                            @Qualifier("modelBuilderPluginRegistry")
                            org.springframework.plugin.core.PluginRegistry<ModelBuilderPlugin,DocumentationType> modelEnrichers,
                            @Qualifier("viewProviderPluginRegistry")
                            org.springframework.plugin.core.PluginRegistry<ViewProviderPlugin,DocumentationType> viewProviders,
                            @Qualifier("syntheticModelProviderPluginRegistry")
                            org.springframework.plugin.core.PluginRegistry<SyntheticModelProviderPlugin,ModelContext> syntheticModelProviders)

Method Detail

property

@Deprecated
public ModelProperty property(ModelPropertyContext context)

Deprecated.

Use propertySpecification(ModelPropertyContext) instead

Parameters:

context - - property context

Returns:

the model property

Since:

3.0.0

model

@Deprecated
public Model model(ModelContext context)

Deprecated.

Use modelSpecification(ModelContext) instead

Parameters:

context - - model context

Returns:

the model

Since:

3.0.0

viewProvider

public ViewProviderPlugin viewProvider(DocumentationType documentationType)

syntheticModel

@Deprecated
public java.util.Optional<Model> syntheticModel(ModelContext context)

Deprecated.

Use syntheticModelSpecification(ModelContext) instead

Parameters:

context - - model context

Returns:

the model

Since:

3.0.0

modelSpecification

public ModelSpecification modelSpecification(ModelContext context)

syntheticModelSpecification

public java.util.Optional<ModelSpecification> syntheticModelSpecification(ModelContext context)

syntheticProperties

@Deprecated
public java.util.List<ModelProperty> syntheticProperties(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(ModelContext context)

syntheticPropertySpecifications

public java.util.List<PropertySpecification> syntheticPropertySpecifications(ModelContext context)

propertySpecification

public PropertySpecification propertySpecification(ModelPropertyContext modelPropertyContext)