springfox.documentation.builders

Class OperationBuilder

java.lang.Object

springfox.documentation.builders.OperationBuilder

public class OperationBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
OperationBuilder(OperationNameGenerator nameGenerator)

Method Summary

Modifier and Type	Method and Description
OperationBuilder	authorizations(java.util.Collection<SecurityReference> securityReferences) Updates the security checks that apply to this operation
Operation	build()
OperationBuilder	codegenMethodNameStem(java.lang.String codeGenMethodNameStem) This is an optional override that provides a custom method name stem, such that the method name that is generated for the purposes of code-gen can be customized.
OperationBuilder	consumes(java.util.Set<java.lang.String> mediaTypes) Updates the existing media types with new entries that this documentation consumes
OperationBuilder	deprecated(java.lang.String deprecated) Marks the listing as deprecated
OperationBuilder	extensions(java.util.List<VendorExtension> extensions) Updates the operation extensions
OperationBuilder	hidden(boolean isHidden) Marks the operation as hidden
OperationBuilder	method(org.springframework.http.HttpMethod method) Updates the http method
OperationBuilder	notes(java.lang.String notes) Updates the operation notes
OperationBuilder	parameters(java.util.List<Parameter> parameters) Updates the input parameters this operation needs
OperationBuilder	position(int position) Updates the index of the operation
OperationBuilder	produces(java.util.Set<java.lang.String> mediaTypes) Updates the existing media types with new entries that this documentation produces
OperationBuilder	protocols(java.util.Set<java.lang.String> protocols) Update the protocols this operation supports
OperationBuilder	responseMessages(java.util.Set<ResponseMessage> responseMessages) Updates the response messages
OperationBuilder	responseModel(ModelReference responseType) Updates the reference to the response model
OperationBuilder	summary(java.lang.String summary) Updates the operation summary
OperationBuilder	tags(java.util.Set<java.lang.String> tags) Updates the tags that identify this operation
OperationBuilder	uniqueId(java.lang.String uniqueId) Updates the uniqueId for the operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationBuilder

public OperationBuilder(OperationNameGenerator nameGenerator)

Method Detail

method

public OperationBuilder method(org.springframework.http.HttpMethod method)

Updates the http method

Parameters:

method - - http method, one of GET, POST, PUT etc.

Returns:

this

summary

public OperationBuilder summary(java.lang.String summary)

Updates the operation summary

Parameters:

summary - - operation summary

Returns:

this

notes

public OperationBuilder notes(java.lang.String notes)

Updates the operation notes

Parameters:

notes - - notes to describe the operation

Returns:

this

uniqueId

public OperationBuilder uniqueId(java.lang.String uniqueId)

Updates the uniqueId for the operation. This will be used to seed the unique id

Parameters:

uniqueId - - uniqueId for the operation

Returns:

this

codegenMethodNameStem

public OperationBuilder codegenMethodNameStem(java.lang.String codeGenMethodNameStem)

This is an optional override that provides a custom method name stem, such that the method name that is generated for the purposes of code-gen can be customized. However it must be kept in mind that in-order the guarantee uniqueness of the name for code-gen the algorithm will still try to append and indexer at the end of it e.g. someMethod_1, someMethod_2 etc. to preserve uniqueness in the case there are duplicate names.

Parameters:

codeGenMethodNameStem - - provides a stem for the operation name as it will be used for code generation

Returns:

this

position

public OperationBuilder position(int position)

Updates the index of the operation

Parameters:

position - - position is used to sort the operation in a particular order

Returns:

this

produces

public OperationBuilder produces(java.util.Set<java.lang.String> mediaTypes)

Updates the existing media types with new entries that this documentation produces

Parameters:

mediaTypes - - new media types

Returns:

this

consumes

public OperationBuilder consumes(java.util.Set<java.lang.String> mediaTypes)

Updates the existing media types with new entries that this documentation consumes

Parameters:

mediaTypes - - new media types

Returns:

this

protocols

public OperationBuilder protocols(java.util.Set<java.lang.String> protocols)

Update the protocols this operation supports

Parameters:

protocols - - protocols

Returns:

this

authorizations

public OperationBuilder authorizations(java.util.Collection<SecurityReference> securityReferences)

Updates the security checks that apply to this operation

Parameters:

securityReferences - - authorization that reference security definitions

Returns:

this

parameters

public OperationBuilder parameters(java.util.List<Parameter> parameters)

Updates the input parameters this operation needs

Parameters:

parameters - - input parameter definitions

Returns:

this

responseMessages

public OperationBuilder responseMessages(java.util.Set<ResponseMessage> responseMessages)

Updates the response messages

Parameters:

responseMessages - - new response messages to be merged with existing response messages

Returns:

this

deprecated

public OperationBuilder deprecated(java.lang.String deprecated)

Marks the listing as deprecated

Parameters:

deprecated - - surely this had to be a boolean!! TODO!!

Returns:

this

hidden

public OperationBuilder hidden(boolean isHidden)

Marks the operation as hidden

Parameters:

isHidden - - boolean flag to indicate that the operation is hidden

Returns:

this

responseModel

public OperationBuilder responseModel(ModelReference responseType)

Updates the reference to the response model

Parameters:

responseType - = response type model reference

Returns:

this

tags

public OperationBuilder tags(java.util.Set<java.lang.String> tags)

Updates the tags that identify this operation

Parameters:

tags - - new set of tags

Returns:

this

extensions

public OperationBuilder extensions(java.util.List<VendorExtension> extensions)

Updates the operation extensions

Parameters:

extensions - - operation extensions

Returns:

this

build

public Operation build()