程序包 springfox.documentation.spi.service.contexts

类 DocumentationContextBuilder

java.lang.Object

springfox.documentation.spi.service.contexts.DocumentationContextBuilder

public class DocumentationContextBuilder
extends Object

构造器概要

构造器

构造器	说明
DocumentationContextBuilder(DocumentationType documentationType)

方法概要

修饰符和类型	方法	说明
DocumentationContextBuilder	additionalIgnorableTypes(Set<Class> ignorableParameterTypes)
DocumentationContextBuilder	additionalModels(Set<com.fasterxml.classmate.ResolvedType> additionalModels)
DocumentationContextBuilder	additionalOperationParameters(List<Parameter> globalRequestParameters)
DocumentationContextBuilder	additionalResponseMessages(Map<org.springframework.web.bind.annotation.RequestMethod,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(Set<String> consumes)
DocumentationContextBuilder	defaultResponseMessages(Map<org.springframework.web.bind.annotation.RequestMethod,List<ResponseMessage>> defaultResponseMessages)
DocumentationContextBuilder	enableUrlTemplating(boolean isUrlTemplatesEnabled)
DocumentationContextBuilder	genericsNaming(GenericTypeNamingStrategy genericsNamingStrategy)
DocumentationContextBuilder	groupName(String groupName)
DocumentationContextBuilder	host(String host)
DocumentationContextBuilder	operationOrdering(com.google.common.collect.Ordering<Operation> operationOrdering)
DocumentationContextBuilder	pathMapping(com.google.common.base.Optional<String> pathMapping)
DocumentationContextBuilder	pathProvider(PathProvider pathProvider)
DocumentationContextBuilder	produces(Set<String> produces)
DocumentationContextBuilder	protocols(Set<String> protocols)
DocumentationContextBuilder	requestHandlers(List<RequestHandler> handlerMappings)
DocumentationContextBuilder	ruleBuilders(List<com.google.common.base.Function<com.fasterxml.classmate.TypeResolver,AlternateTypeRule>> ruleBuilders)
DocumentationContextBuilder	rules(List<AlternateTypeRule> rules)
DocumentationContextBuilder	securityContexts(List<SecurityContext> securityContext)
DocumentationContextBuilder	securitySchemes(List<? extends SecurityScheme> securitySchemes)
DocumentationContextBuilder	selector(ApiSelector apiSelector)
DocumentationContextBuilder	tags(Set<Tag> tags)
DocumentationContextBuilder	typeResolver(com.fasterxml.classmate.TypeResolver typeResolver)
DocumentationContextBuilder	vendorExtentions(List<VendorExtension> vendorExtensions)
DocumentationContextBuilder	withResourceGroupingStrategy(ResourceGroupingStrategy resourceGroupingStrategy)	已过时。

从类继承的方法 java.lang.Object

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

构造器详细资料

DocumentationContextBuilder

public DocumentationContextBuilder(DocumentationType documentationType)

方法详细资料

requestHandlers

public DocumentationContextBuilder requestHandlers(List<RequestHandler> handlerMappings)

apiInfo

public DocumentationContextBuilder apiInfo(ApiInfo apiInfo)

groupName

public DocumentationContextBuilder groupName(String groupName)

additionalIgnorableTypes

public DocumentationContextBuilder additionalIgnorableTypes(Set<Class> ignorableParameterTypes)

additionalResponseMessages

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

additionalOperationParameters

public DocumentationContextBuilder additionalOperationParameters(List<Parameter> globalRequestParameters)

withResourceGroupingStrategy

@Deprecated
public DocumentationContextBuilder withResourceGroupingStrategy(ResourceGroupingStrategy resourceGroupingStrategy)

已过时。

参数:

resourceGroupingStrategy - - custom resource grouping strategy

返回:

this

从以下版本开始:

2.2.0 - only here for backward compatibility

pathProvider

public DocumentationContextBuilder pathProvider(PathProvider pathProvider)

securityContexts

public DocumentationContextBuilder securityContexts(List<SecurityContext> securityContext)

securitySchemes

public DocumentationContextBuilder securitySchemes(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(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(List<AlternateTypeRule> rules)

defaultResponseMessages

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

produces

public DocumentationContextBuilder produces(Set<String> produces)

consumes

public DocumentationContextBuilder consumes(Set<String> consumes)

genericsNaming

public DocumentationContextBuilder genericsNaming(GenericTypeNamingStrategy genericsNamingStrategy)

host

public DocumentationContextBuilder host(String host)

protocols

public DocumentationContextBuilder protocols(Set<String> protocols)

selector

public DocumentationContextBuilder selector(ApiSelector apiSelector)

pathMapping

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

enableUrlTemplating

public DocumentationContextBuilder enableUrlTemplating(boolean isUrlTemplatesEnabled)

additionalModels

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

tags

public DocumentationContextBuilder tags(Set<Tag> tags)

vendorExtentions

public DocumentationContextBuilder vendorExtentions(List<VendorExtension> vendorExtensions)

build

public DocumentationContext build()