springfox.documentation.spi.schema

Interface ViewProviderPlugin

All Superinterfaces:

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

public interface ViewProviderPlugin
extends org.springframework.plugin.core.Plugin<DocumentationType>

Method Summary

Modifier and Type	Method and Description
java.util.Optional<com.fasterxml.classmate.ResolvedType>	viewFor(com.fasterxml.classmate.ResolvedType type, OperationContext context) Finds a active view for the return type
java.util.Optional<com.fasterxml.classmate.ResolvedType>	viewFor(com.fasterxml.classmate.ResolvedType type, RequestMappingContext context) Finds a active view for the return type
java.util.Optional<com.fasterxml.classmate.ResolvedType>	viewFor(com.fasterxml.classmate.ResolvedType type, springfox.documentation.service.ResolvedMethodParameter parameter) Finds a active view for the parameter type

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

supports

Method Detail

viewFor

java.util.Optional<com.fasterxml.classmate.ResolvedType> viewFor(com.fasterxml.classmate.ResolvedType type,
                                                                 springfox.documentation.service.ResolvedMethodParameter parameter)

Finds a active view for the parameter type

Parameters:

type - - resolved type to provide view for

parameter - - resolved method parameter to take additional information from, if needed

Returns:

resolved view name, if found

viewFor

java.util.Optional<com.fasterxml.classmate.ResolvedType> viewFor(com.fasterxml.classmate.ResolvedType type,
                                                                 RequestMappingContext context)

Finds a active view for the return type

Parameters:

type - - resolved type to provide view for

context - - method context to take additional information from, if needed

Returns:

resolved view name, if found

viewFor

java.util.Optional<com.fasterxml.classmate.ResolvedType> viewFor(com.fasterxml.classmate.ResolvedType type,
                                                                 OperationContext context)

Finds a active view for the return type

Parameters:

type - - resolved type to provide view for

context - - operation context to take additional information from, if needed

Returns:

resolved view name, if found