springfox.documentation.spi.service.contexts

Class DocumentationContextBuilder

java.lang.Object

springfox.documentation.spi.service.contexts.DocumentationContextBuilder

public class DocumentationContextBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DocumentationContextBuilder(DocumentationType documentationType)

Method Summary

Modifier and Type	Method and Description
DocumentationContextBuilder	additionalIgnorableTypes(java.util.Set<java.lang.Class> ignorableParameterTypes)
DocumentationContextBuilder	additionalModels(java.util.Set<com.fasterxml.classmate.ResolvedType> additionalModels)
DocumentationContextBuilder	additionalOperationParameters(java.util.List<Parameter> globalRequestParameters)
DocumentationContextBuilder	additionalResponseMessages(java.util.Map<org.springframework.web.bind.annotation.RequestMethod,java.util.List<ResponseMessage>> additionalResponseMessages)
DocumentationContextBuilder	apiDescriptionOrdering(com.google.common.collect.Ordering<ApiDescription> apiDescriptionOrdering)
DocumentationContextBuilder	apiInfo(ApiInfo apiInfo)
DocumentationContextBuilder	apiListingReferenceOrdering(com.google.common.collect.Ordering<ApiListingReference> listingReferenceOrdering)
DocumentationContextBuilder	applyDefaultResponseMessages(boolean applyDefaultResponseMessages)
DocumentationContext	build()
DocumentationContextBuilder	consumes(java.util.Set<java.lang.String> consumes)
DocumentationContextBuilder	defaultResponseMessages(java.util.Map<org.springframework.web.bind.annotation.RequestMethod,java.util.List<ResponseMessage>> defaultResponseMessages)
DocumentationContextBuilder	enableUrlTemplating(boolean isUrlTemplatesEnabled)
DocumentationContextBuilder	genericsNaming(GenericTypeNamingStrategy genericsNamingStrategy)
DocumentationContextBuilder	groupName(java.lang.String groupName)
DocumentationContextBuilder	host(java.lang.String host)
DocumentationContextBuilder	operationOrdering(com.google.common.collect.Ordering<Operation> operationOrdering)
DocumentationContextBuilder	pathMapping(com.google.common.base.Optional<java.lang.String> pathMapping)
DocumentationContextBuilder	pathProvider(PathProvider pathProvider)
DocumentationContextBuilder	produces(java.util.Set<java.lang.String> produces)
DocumentationContextBuilder	protocols(java.util.Set<java.lang.String> protocols)
DocumentationContextBuilder	requestHandlers(java.util.List<RequestHandler> handlerMappings)
DocumentationContextBuilder	ruleBuilders(java.util.List<com.google.common.base.Function<com.fasterxml.classmate.TypeResolver,AlternateTypeRule>> ruleBuilders)
DocumentationContextBuilder	rules(java.util.List<AlternateTypeRule> rules)
DocumentationContextBuilder	securityContexts(java.util.List<SecurityContext> securityContext)
DocumentationContextBuilder	securitySchemes(java.util.List<? extends SecurityScheme> securitySchemes)
DocumentationContextBuilder	selector(ApiSelector apiSelector)
DocumentationContextBuilder	tags(java.util.Set<Tag> tags)
DocumentationContextBuilder	typeResolver(com.fasterxml.classmate.TypeResolver typeResolver)
DocumentationContextBuilder	vendorExtentions(java.util.List<VendorExtension> vendorExtensions)
DocumentationContextBuilder	withResourceGroupingStrategy(ResourceGroupingStrategy resourceGroupingStrategy) Deprecated. @since 2.2.0 - only here for backward compatibility

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationContextBuilder

public DocumentationContextBuilder(DocumentationType documentationType)

Method Detail

requestHandlers

public DocumentationContextBuilder requestHandlers(java.util.List<RequestHandler> handlerMappings)

apiInfo

public DocumentationContextBuilder apiInfo(ApiInfo apiInfo)

groupName

public DocumentationContextBuilder groupName(java.lang.String groupName)

additionalIgnorableTypes

public DocumentationContextBuilder additionalIgnorableTypes(java.util.Set<java.lang.Class> ignorableParameterTypes)

additionalResponseMessages

public DocumentationContextBuilder additionalResponseMessages(java.util.Map<org.springframework.web.bind.annotation.RequestMethod,java.util.List<ResponseMessage>> additionalResponseMessages)

additionalOperationParameters

public DocumentationContextBuilder additionalOperationParameters(java.util.List<Parameter> globalRequestParameters)

withResourceGroupingStrategy

@Deprecated
public DocumentationContextBuilder withResourceGroupingStrategy(ResourceGroupingStrategy resourceGroupingStrategy)

Deprecated. @since 2.2.0 - only here for backward compatibility

Parameters:

resourceGroupingStrategy - - custom resource grouping strategy

Returns:

this

pathProvider

public DocumentationContextBuilder pathProvider(PathProvider pathProvider)

securityContexts

public DocumentationContextBuilder securityContexts(java.util.List<SecurityContext> securityContext)

securitySchemes

public DocumentationContextBuilder securitySchemes(java.util.List<? extends SecurityScheme> securitySchemes)

apiListingReferenceOrdering

public DocumentationContextBuilder apiListingReferenceOrdering(com.google.common.collect.Ordering<ApiListingReference> listingReferenceOrdering)

apiDescriptionOrdering

public DocumentationContextBuilder apiDescriptionOrdering(com.google.common.collect.Ordering<ApiDescription> apiDescriptionOrdering)

applyDefaultResponseMessages

public DocumentationContextBuilder applyDefaultResponseMessages(boolean applyDefaultResponseMessages)

ruleBuilders

public DocumentationContextBuilder ruleBuilders(java.util.List<com.google.common.base.Function<com.fasterxml.classmate.TypeResolver,AlternateTypeRule>> ruleBuilders)

typeResolver

public DocumentationContextBuilder typeResolver(com.fasterxml.classmate.TypeResolver typeResolver)

operationOrdering

public DocumentationContextBuilder operationOrdering(com.google.common.collect.Ordering<Operation> operationOrdering)

rules

public DocumentationContextBuilder rules(java.util.List<AlternateTypeRule> rules)

defaultResponseMessages

public DocumentationContextBuilder defaultResponseMessages(java.util.Map<org.springframework.web.bind.annotation.RequestMethod,java.util.List<ResponseMessage>> defaultResponseMessages)

produces

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

consumes

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

genericsNaming

public DocumentationContextBuilder genericsNaming(GenericTypeNamingStrategy genericsNamingStrategy)

host

public DocumentationContextBuilder host(java.lang.String host)

protocols

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

selector

public DocumentationContextBuilder selector(ApiSelector apiSelector)

pathMapping

public DocumentationContextBuilder pathMapping(com.google.common.base.Optional<java.lang.String> pathMapping)

enableUrlTemplating

public DocumentationContextBuilder enableUrlTemplating(boolean isUrlTemplatesEnabled)

additionalModels

public DocumentationContextBuilder additionalModels(java.util.Set<com.fasterxml.classmate.ResolvedType> additionalModels)

tags

public DocumentationContextBuilder tags(java.util.Set<Tag> tags)

vendorExtentions

public DocumentationContextBuilder vendorExtentions(java.util.List<VendorExtension> vendorExtensions)

build

public DocumentationContext build()