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