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

类 DocumentationContext

java.lang.Object

springfox.documentation.spi.service.contexts.DocumentationContext

public class DocumentationContext
extends Object

构造器概要

构造器

构造器

说明

DocumentationContext(DocumentationType documentationType, List<RequestHandler> handlerMappings, ApiInfo apiInfo, String groupName, ApiSelector apiSelector, Set<Class> ignorableParameterTypes, Map<org.springframework.web.bind.annotation.RequestMethod,List<ResponseMessage>> globalResponseMessages, List<Parameter> globalOperationParameter, ResourceGroupingStrategy resourceGroupingStrategy, PathProvider pathProvider, List<SecurityContext> securityContexts, List<? extends SecurityScheme> securitySchemes, List<AlternateTypeRule> alternateTypeRules, com.google.common.collect.Ordering<ApiListingReference> listingReferenceOrdering, com.google.common.collect.Ordering<ApiDescription> apiDescriptionOrdering, com.google.common.collect.Ordering<Operation> operationOrdering, Set<String> produces, Set<String> consumes, String host, Set<String> protocols, GenericTypeNamingStrategy genericsNamingStrategy, com.google.common.base.Optional<String> pathMapping, boolean isUriTemplatesEnabled, Set<com.fasterxml.classmate.ResolvedType> additionalModels, Set<Tag> tags, List<VendorExtension> vendorExtensions)

方法概要

修饰符和类型	方法	说明
Set<com.fasterxml.classmate.ResolvedType>	getAdditionalModels()
AlternateTypeProvider	getAlternateTypeProvider()
com.google.common.collect.Ordering<ApiDescription>	getApiDescriptionOrdering()
ApiInfo	getApiInfo()
ApiSelector	getApiSelector()
Set<String>	getConsumes()
DocumentationType	getDocumentationType()
GenericTypeNamingStrategy	getGenericsNamingStrategy()
List<Parameter>	getGlobalRequestParameters()
Map<org.springframework.web.bind.annotation.RequestMethod,List<ResponseMessage>>	getGlobalResponseMessages()
String	getGroupName()
String	getHost()
com.google.common.collect.ImmutableSet<Class>	getIgnorableParameterTypes()
com.google.common.collect.Ordering<ApiListingReference>	getListingReferenceOrdering()
com.google.common.base.Optional<String>	getPathMapping()
PathProvider	getPathProvider()
Set<String>	getProduces()
Set<String>	getProtocols()
List<RequestHandler>	getRequestHandlers()
ResourceGroupingStrategy	getResourceGroupingStrategy()	已过时。
List<SecurityContext>	getSecurityContexts()
List<? extends SecurityScheme>	getSecuritySchemes()
Set<Tag>	getTags()
List<VendorExtension>	getVendorExtentions()
boolean	isUriTemplatesEnabled()
com.google.common.collect.Ordering<Operation>	operationOrdering()

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

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

构造器详细资料

DocumentationContext

public DocumentationContext(DocumentationType documentationType,
 List<RequestHandler> handlerMappings,
 ApiInfo apiInfo,
 String groupName,
 ApiSelector apiSelector,
 Set<Class> ignorableParameterTypes,
 Map<org.springframework.web.bind.annotation.RequestMethod,List<ResponseMessage>> globalResponseMessages,
 List<Parameter> globalOperationParameter,
 ResourceGroupingStrategy resourceGroupingStrategy,
 PathProvider pathProvider,
 List<SecurityContext> securityContexts,
 List<? extends SecurityScheme> securitySchemes,
 List<AlternateTypeRule> alternateTypeRules,
 com.google.common.collect.Ordering<ApiListingReference> listingReferenceOrdering,
 com.google.common.collect.Ordering<ApiDescription> apiDescriptionOrdering,
 com.google.common.collect.Ordering<Operation> operationOrdering,
 Set<String> produces,
 Set<String> consumes,
 String host,
 Set<String> protocols,
 GenericTypeNamingStrategy genericsNamingStrategy,
 com.google.common.base.Optional<String> pathMapping,
 boolean isUriTemplatesEnabled,
 Set<com.fasterxml.classmate.ResolvedType> additionalModels,
 Set<Tag> tags,
 List<VendorExtension> vendorExtensions)

方法详细资料

getDocumentationType

public DocumentationType getDocumentationType()

getRequestHandlers

public List<RequestHandler> getRequestHandlers()

getApiInfo

public ApiInfo getApiInfo()

getGroupName

public String getGroupName()

getApiSelector

public ApiSelector getApiSelector()

getIgnorableParameterTypes

public com.google.common.collect.ImmutableSet<Class> getIgnorableParameterTypes()

getGlobalResponseMessages

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

getGlobalRequestParameters

public List<Parameter> getGlobalRequestParameters()

getResourceGroupingStrategy

@Deprecated
public ResourceGroupingStrategy getResourceGroupingStrategy()

已过时。

返回:

resource grouping strategy

从以下版本开始:

2.2.0 - only here for backward compatibility

getPathProvider

public PathProvider getPathProvider()

getSecurityContexts

public List<SecurityContext> getSecurityContexts()

getSecuritySchemes

public List<? extends SecurityScheme> getSecuritySchemes()

getListingReferenceOrdering

public com.google.common.collect.Ordering<ApiListingReference> getListingReferenceOrdering()

getApiDescriptionOrdering

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

getAlternateTypeProvider

public AlternateTypeProvider getAlternateTypeProvider()

operationOrdering

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

getProduces

public Set<String> getProduces()

getConsumes

public Set<String> getConsumes()

getHost

public String getHost()

getProtocols

public Set<String> getProtocols()

getGenericsNamingStrategy

public GenericTypeNamingStrategy getGenericsNamingStrategy()

getPathMapping

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

isUriTemplatesEnabled

public boolean isUriTemplatesEnabled()

getAdditionalModels

public Set<com.fasterxml.classmate.ResolvedType> getAdditionalModels()

getTags

public Set<Tag> getTags()

getVendorExtentions

public List<VendorExtension> getVendorExtentions()