public class DocumentationContext
extends java.lang.Object
Constructor and Description |
---|
DocumentationContext(DocumentationType documentationType,
java.util.List<springfox.documentation.RequestHandler> handlerMappings,
springfox.documentation.service.ApiInfo apiInfo,
java.lang.String groupName,
ApiSelector apiSelector,
java.util.Set<java.lang.Class> ignorableParameterTypes,
java.util.Map<org.springframework.web.bind.annotation.RequestMethod,java.util.List<springfox.documentation.service.ResponseMessage>> globalResponseMessages,
java.util.List<springfox.documentation.service.Parameter> globalOperationParameter,
ResourceGroupingStrategy resourceGroupingStrategy,
springfox.documentation.PathProvider pathProvider,
java.util.List<SecurityContext> securityContexts,
java.util.List<? extends springfox.documentation.service.SecurityScheme> securitySchemes,
java.util.List<springfox.documentation.schema.AlternateTypeRule> alternateTypeRules,
com.google.common.collect.Ordering<springfox.documentation.service.ApiListingReference> listingReferenceOrdering,
com.google.common.collect.Ordering<springfox.documentation.service.ApiDescription> apiDescriptionOrdering,
com.google.common.collect.Ordering<springfox.documentation.service.Operation> operationOrdering,
java.util.Set<java.lang.String> produces,
java.util.Set<java.lang.String> consumes,
java.lang.String host,
java.util.Set<java.lang.String> protocols,
GenericTypeNamingStrategy genericsNamingStrategy,
com.google.common.base.Optional<java.lang.String> pathMapping,
boolean isUriTemplatesEnabled,
java.util.Set<com.fasterxml.classmate.ResolvedType> additionalModels,
java.util.Set<springfox.documentation.service.Tag> tags) |
Modifier and Type | Method and Description |
---|---|
java.util.Set<com.fasterxml.classmate.ResolvedType> |
getAdditionalModels() |
AlternateTypeProvider |
getAlternateTypeProvider() |
com.google.common.collect.Ordering<springfox.documentation.service.ApiDescription> |
getApiDescriptionOrdering() |
springfox.documentation.service.ApiInfo |
getApiInfo() |
ApiSelector |
getApiSelector() |
java.util.Set<java.lang.String> |
getConsumes() |
DocumentationType |
getDocumentationType() |
GenericTypeNamingStrategy |
getGenericsNamingStrategy() |
java.util.List<springfox.documentation.service.Parameter> |
getGlobalRequestParameters() |
java.util.Map<org.springframework.web.bind.annotation.RequestMethod,java.util.List<springfox.documentation.service.ResponseMessage>> |
getGlobalResponseMessages() |
java.lang.String |
getGroupName() |
java.lang.String |
getHost() |
com.google.common.collect.ImmutableSet<java.lang.Class> |
getIgnorableParameterTypes() |
com.google.common.collect.Ordering<springfox.documentation.service.ApiListingReference> |
getListingReferenceOrdering() |
com.google.common.base.Optional<java.lang.String> |
getPathMapping() |
springfox.documentation.PathProvider |
getPathProvider() |
java.util.Set<java.lang.String> |
getProduces() |
java.util.Set<java.lang.String> |
getProtocols() |
java.util.List<springfox.documentation.RequestHandler> |
getRequestHandlers() |
ResourceGroupingStrategy |
getResourceGroupingStrategy()
Deprecated.
@since 2.2.0 - only here for backward compatibiltiy
|
java.util.List<SecurityContext> |
getSecurityContexts() |
java.util.List<? extends springfox.documentation.service.SecurityScheme> |
getSecuritySchemes() |
java.util.Set<springfox.documentation.service.Tag> |
getTags() |
boolean |
isUriTemplatesEnabled() |
com.google.common.collect.Ordering<springfox.documentation.service.Operation> |
operationOrdering() |
public DocumentationContext(DocumentationType documentationType, java.util.List<springfox.documentation.RequestHandler> handlerMappings, springfox.documentation.service.ApiInfo apiInfo, java.lang.String groupName, ApiSelector apiSelector, java.util.Set<java.lang.Class> ignorableParameterTypes, java.util.Map<org.springframework.web.bind.annotation.RequestMethod,java.util.List<springfox.documentation.service.ResponseMessage>> globalResponseMessages, java.util.List<springfox.documentation.service.Parameter> globalOperationParameter, ResourceGroupingStrategy resourceGroupingStrategy, springfox.documentation.PathProvider pathProvider, java.util.List<SecurityContext> securityContexts, java.util.List<? extends springfox.documentation.service.SecurityScheme> securitySchemes, java.util.List<springfox.documentation.schema.AlternateTypeRule> alternateTypeRules, com.google.common.collect.Ordering<springfox.documentation.service.ApiListingReference> listingReferenceOrdering, com.google.common.collect.Ordering<springfox.documentation.service.ApiDescription> apiDescriptionOrdering, com.google.common.collect.Ordering<springfox.documentation.service.Operation> operationOrdering, java.util.Set<java.lang.String> produces, java.util.Set<java.lang.String> consumes, java.lang.String host, java.util.Set<java.lang.String> protocols, GenericTypeNamingStrategy genericsNamingStrategy, com.google.common.base.Optional<java.lang.String> pathMapping, boolean isUriTemplatesEnabled, java.util.Set<com.fasterxml.classmate.ResolvedType> additionalModels, java.util.Set<springfox.documentation.service.Tag> tags)
public DocumentationType getDocumentationType()
public java.util.List<springfox.documentation.RequestHandler> getRequestHandlers()
public springfox.documentation.service.ApiInfo getApiInfo()
public java.lang.String getGroupName()
public ApiSelector getApiSelector()
public com.google.common.collect.ImmutableSet<java.lang.Class> getIgnorableParameterTypes()
public java.util.Map<org.springframework.web.bind.annotation.RequestMethod,java.util.List<springfox.documentation.service.ResponseMessage>> getGlobalResponseMessages()
public java.util.List<springfox.documentation.service.Parameter> getGlobalRequestParameters()
@Deprecated public ResourceGroupingStrategy getResourceGroupingStrategy()
public springfox.documentation.PathProvider getPathProvider()
public java.util.List<SecurityContext> getSecurityContexts()
public java.util.List<? extends springfox.documentation.service.SecurityScheme> getSecuritySchemes()
public com.google.common.collect.Ordering<springfox.documentation.service.ApiListingReference> getListingReferenceOrdering()
public com.google.common.collect.Ordering<springfox.documentation.service.ApiDescription> getApiDescriptionOrdering()
public AlternateTypeProvider getAlternateTypeProvider()
public com.google.common.collect.Ordering<springfox.documentation.service.Operation> operationOrdering()
public java.util.Set<java.lang.String> getProduces()
public java.util.Set<java.lang.String> getConsumes()
public java.lang.String getHost()
public java.util.Set<java.lang.String> getProtocols()
public GenericTypeNamingStrategy getGenericsNamingStrategy()
public com.google.common.base.Optional<java.lang.String> getPathMapping()
public boolean isUriTemplatesEnabled()
public java.util.Set<com.fasterxml.classmate.ResolvedType> getAdditionalModels()
public java.util.Set<springfox.documentation.service.Tag> getTags()