springfox.documentation.spring.web.plugins

Class SpringRestDocsOperationBuilderPlugin

java.lang.Object

springfox.documentation.spring.web.plugins.SpringRestDocsOperationBuilderPlugin

All Implemented Interfaces:

org.springframework.plugin.core.Plugin<springfox.documentation.spi.DocumentationType>, springfox.documentation.spi.service.OperationBuilderPlugin

@Component
 @Order(value=-2147482648)
public class SpringRestDocsOperationBuilderPlugin
extends java.lang.Object
implements springfox.documentation.spi.service.OperationBuilderPlugin

Constructor Summary

Constructors

Constructor and Description
SpringRestDocsOperationBuilderPlugin()

Method Summary

Modifier and Type	Method and Description
void	apply(springfox.documentation.spi.service.contexts.OperationContext context)
protected java.util.Set<springfox.documentation.service.ResponseMessage>	read(springfox.documentation.spi.service.contexts.OperationContext context) Provides response messages with examples for given single operation context.
boolean	supports(springfox.documentation.spi.DocumentationType documentationType)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringRestDocsOperationBuilderPlugin

public SpringRestDocsOperationBuilderPlugin()

Method Detail

apply

public void apply(springfox.documentation.spi.service.contexts.OperationContext context)

Specified by:

apply in interface springfox.documentation.spi.service.OperationBuilderPlugin

supports

public boolean supports(springfox.documentation.spi.DocumentationType documentationType)

Specified by:

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

read

protected java.util.Set<springfox.documentation.service.ResponseMessage> read(springfox.documentation.spi.service.contexts.OperationContext context)

Provides response messages with examples for given single operation context.

Parameters:

context - representing an operation

Returns:

response messages.