springfox.documentation.spi.schema

Interface SyntheticModelProviderPlugin

All Superinterfaces:

org.springframework.plugin.core.Plugin<ModelContext>

public interface SyntheticModelProviderPlugin
extends org.springframework.plugin.core.Plugin<ModelContext>

Plugin to generate custom models

Since:

2.8.1

Method Summary

Modifier and Type	Method and Description
Model	create(ModelContext context) Creates a synthetic model
java.util.Set<com.fasterxml.classmate.ResolvedType>	dependencies(ModelContext context) Creates a dependencies for the synthetic model
java.util.List<ModelProperty>	properties(ModelContext context) Creates a synthetic model properties

Methods inherited from interface org.springframework.plugin.core.Plugin

supports

Method Detail

create

Model create(ModelContext context)

Creates a synthetic model

Parameters:

context - - context to create the model from

Returns:

model - when the plugin indicates it supports it, it must return a model

properties

java.util.List<ModelProperty> properties(ModelContext context)

Creates a synthetic model properties

Parameters:

context - - context to create the model properties from

Returns:

model - when the plugin indicates it supports it, it must provide properties by name

dependencies

java.util.Set<com.fasterxml.classmate.ResolvedType> dependencies(ModelContext context)

Creates a dependencies for the synthetic model

Parameters:

context - - context to create the model dependencies from

Returns:

model - when the plugin indicates it supports it, it may return dependent model types.