Package springfox.documentation.schema

Class JacksonJsonViewProvider

java.lang.Object

springfox.documentation.schema.JacksonJsonViewProvider

All Implemented Interfaces:

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

@Component
@Order
public class JacksonJsonViewProvider
extends java.lang.Object
implements ViewProviderPlugin

Constructor Summary

Constructors

Constructor	Description
JacksonJsonViewProvider(com.fasterxml.classmate.TypeResolver typeResolver)

Method Summary

Modifier and Type	Method	Description
boolean	supports(DocumentationType delimiter)
java.util.Optional<com.fasterxml.classmate.ResolvedType>	viewFor(ResolvedMethodParameter parameter)	Finds a active view for the parameter type
java.util.Optional<com.fasterxml.classmate.ResolvedType>	viewFor(OperationContext context)	Finds a active view for the return type
java.util.Optional<com.fasterxml.classmate.ResolvedType>	viewFor(RequestMappingContext context)	Finds a active view for the return type

Methods inherited from class java.lang.Object

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

Constructor Detail

JacksonJsonViewProvider

@Autowired
public JacksonJsonViewProvider(com.fasterxml.classmate.TypeResolver typeResolver)

Method Detail

supports

public boolean supports(DocumentationType delimiter)

Specified by:

supports in interface org.springframework.plugin.core.Plugin<DocumentationType>

viewFor

public java.util.Optional<com.fasterxml.classmate.ResolvedType> viewFor(ResolvedMethodParameter parameter)

Description copied from interface: ViewProviderPlugin

Finds a active view for the parameter type

Specified by:

viewFor in interface ViewProviderPlugin

Parameters:

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

Returns:

resolved view name, if found

viewFor

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

Description copied from interface: ViewProviderPlugin

Finds a active view for the return type

Specified by:

viewFor in interface ViewProviderPlugin

Parameters:

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

Returns:

resolved view name, if found

viewFor

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

Description copied from interface: ViewProviderPlugin

Finds a active view for the return type

Specified by:

viewFor in interface ViewProviderPlugin

Parameters:

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

Returns:

resolved view name, if found