Class SpringRestDocsOperationBuilderPlugin
- java.lang.Object
-
- springfox.documentation.spring.web.plugins.SpringRestDocsOperationBuilderPlugin
-
- All Implemented Interfaces:
org.springframework.plugin.core.Plugin<DocumentationType>,OperationBuilderPlugin
@Component @Order(-2147482648) public class SpringRestDocsOperationBuilderPlugin extends java.lang.Object implements OperationBuilderPlugin
-
-
Constructor Summary
Constructors Constructor Description SpringRestDocsOperationBuilderPlugin()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidapply(OperationContext context)Implement this method to override the Operation using the OperationBuilder available in the contextprotected java.util.Set<Response>read(OperationContext context)Provides response messages with examples for given single operation context.booleansupports(DocumentationType documentationType)
-
-
-
Method Detail
-
apply
public void apply(OperationContext context)
Description copied from interface:OperationBuilderPluginImplement this method to override the Operation using the OperationBuilder available in the context- Specified by:
applyin interfaceOperationBuilderPlugin- Parameters:
context- - context that can be used to override the parameter attributes- See Also:
Operation,OperationBuilder
-
supports
public boolean supports(DocumentationType documentationType)
- Specified by:
supportsin interfaceorg.springframework.plugin.core.Plugin<DocumentationType>
-
read
protected java.util.Set<Response> read(OperationContext context)
Provides response messages with examples for given single operation context.- Parameters:
context- representing an operation- Returns:
- response messages.
-
-