springfox.documentation.spring.web.readers.parameter

Class ParameterRequiredReader

java.lang.Object

springfox.documentation.spring.web.readers.parameter.ParameterRequiredReader

All Implemented Interfaces:

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

@Component
@Order(value=-2147483648)
public class ParameterRequiredReader
extends java.lang.Object
implements ParameterBuilderPlugin

Constructor Summary

Constructors

Constructor and Description
ParameterRequiredReader(DescriptionResolver descriptions)

Method Summary

Methods

Modifier and Type	Method and Description
void	apply(ParameterContext context) Implement this method to collect input parameters and return values
boolean	supports(DocumentationType delimiter)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterRequiredReader

@Autowired
public ParameterRequiredReader(DescriptionResolver descriptions)

Method Detail

apply

public void apply(ParameterContext context)

Description copied from interface: ParameterBuilderPlugin

Implement this method to collect input parameters and return values

Specified by:

apply in interface ParameterBuilderPlugin

Parameters:

context - - context that can be used to override the parameter attributes

See Also:

Parameter, ParameterBuilder

supports

public boolean supports(DocumentationType delimiter)

Specified by:

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