Package 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	Description
DocumentationContextBuilder(DocumentationType documentationType)

Method Summary

Modifier and Type	Method	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<springfox.documentation.service.Parameter> globalRequestParameters)
DocumentationContextBuilder	additionalRequestParameters(java.util.List<springfox.documentation.service.RequestParameter> globalRequestParameters)
DocumentationContextBuilder	additionalResponseMessages(java.util.Map<org.springframework.web.bind.annotation.RequestMethod,java.util.List<springfox.documentation.service.ResponseMessage>> additionalResponseMessages)
DocumentationContextBuilder	additionalResponses(java.util.Map<org.springframework.http.HttpMethod,java.util.List<springfox.documentation.service.Response>> additionalResponses)
DocumentationContextBuilder	apiDescriptionOrdering(java.util.Comparator<springfox.documentation.service.ApiDescription> apiDescriptionOrdering)
DocumentationContextBuilder	apiInfo(springfox.documentation.service.ApiInfo apiInfo)
DocumentationContextBuilder	apiListingReferenceOrdering(java.util.Comparator<springfox.documentation.service.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<springfox.documentation.service.ResponseMessage>> defaultResponseMessages)	Deprecated.
DocumentationContextBuilder	defaultResponses(java.util.Map<org.springframework.http.HttpMethod,java.util.List<springfox.documentation.service.Response>> defaultResponses)
DocumentationContextBuilder	enableUrlTemplating(boolean isUrlTemplatesEnabled)
DocumentationContextBuilder	genericsNaming(GenericTypeNamingStrategy genericsNamingStrategy)
DocumentationContextBuilder	groupName(java.lang.String groupName)
DocumentationContextBuilder	host(java.lang.String host)
DocumentationContextBuilder	operationOrdering(java.util.Comparator<springfox.documentation.service.Operation> operationOrdering)
DocumentationContextBuilder	pathMapping(java.util.Optional<java.lang.String> pathMapping)
DocumentationContextBuilder	pathProvider(springfox.documentation.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<springfox.documentation.RequestHandler> handlerMappings)
DocumentationContextBuilder	ruleBuilders(java.util.List<java.util.function.Function<com.fasterxml.classmate.TypeResolver,springfox.documentation.schema.AlternateTypeRule>> ruleBuilders)
DocumentationContextBuilder	rules(java.util.List<springfox.documentation.schema.AlternateTypeRule> rules)
DocumentationContextBuilder	securityContexts(java.util.List<SecurityContext> securityContext)
DocumentationContextBuilder	securitySchemes(java.util.List<springfox.documentation.service.SecurityScheme> securitySchemes)
DocumentationContextBuilder	selector(ApiSelector apiSelector)
DocumentationContextBuilder	servers(java.util.List<springfox.documentation.service.Server> servers)
DocumentationContextBuilder	tags(java.util.Set<springfox.documentation.service.Tag> tags)
DocumentationContextBuilder	typeResolver(com.fasterxml.classmate.TypeResolver typeResolver)
DocumentationContextBuilder	vendorExtentions(java.util.List<springfox.documentation.service.VendorExtension> vendorExtensions)

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<springfox.documentation.RequestHandler> handlerMappings)

apiInfo

public DocumentationContextBuilder apiInfo(springfox.documentation.service.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<springfox.documentation.service.ResponseMessage>> additionalResponseMessages)

additionalResponses

public DocumentationContextBuilder additionalResponses(java.util.Map<org.springframework.http.HttpMethod,java.util.List<springfox.documentation.service.Response>> additionalResponses)

additionalOperationParameters

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

pathProvider

public DocumentationContextBuilder pathProvider(springfox.documentation.PathProvider pathProvider)

securityContexts

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

securitySchemes

public DocumentationContextBuilder securitySchemes(java.util.List<springfox.documentation.service.SecurityScheme> securitySchemes)

apiListingReferenceOrdering

public DocumentationContextBuilder apiListingReferenceOrdering(java.util.Comparator<springfox.documentation.service.ApiListingReference> listingReferenceOrdering)

apiDescriptionOrdering

public DocumentationContextBuilder apiDescriptionOrdering(java.util.Comparator<springfox.documentation.service.ApiDescription> apiDescriptionOrdering)

applyDefaultResponseMessages

public DocumentationContextBuilder applyDefaultResponseMessages(boolean applyDefaultResponseMessages)

ruleBuilders

public DocumentationContextBuilder ruleBuilders(java.util.List<java.util.function.Function<com.fasterxml.classmate.TypeResolver,springfox.documentation.schema.AlternateTypeRule>> ruleBuilders)

typeResolver

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

operationOrdering

public DocumentationContextBuilder operationOrdering(java.util.Comparator<springfox.documentation.service.Operation> operationOrdering)

rules

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

defaultResponseMessages

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

Deprecated.

Used to populate the defaults

Parameters:

defaultResponseMessages - - default response messages

Returns:

DocumentationContextBuilder

Since:

3.1.0 Use defaultResponses instead

defaultResponses

public DocumentationContextBuilder defaultResponses(java.util.Map<org.springframework.http.HttpMethod,java.util.List<springfox.documentation.service.Response>> defaultResponses)

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(java.util.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<springfox.documentation.service.Tag> tags)

vendorExtentions

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

additionalRequestParameters

public DocumentationContextBuilder additionalRequestParameters(java.util.List<springfox.documentation.service.RequestParameter> globalRequestParameters)

build

public DocumentationContext build()

servers

public DocumentationContextBuilder servers(java.util.List<springfox.documentation.service.Server> servers)