Package springfox.documentation.spi.service.contexts

Class DocumentationContext

java.lang.Object

springfox.documentation.spi.service.contexts.DocumentationContext

public class DocumentationContext
extends java.lang.Object

Constructor Summary

Constructors

Constructor

Description

DocumentationContext(DocumentationType documentationType, java.util.List<RequestHandler> handlerMappings, 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<ResponseMessage>> globalResponseMessages, java.util.List<Parameter> globalOperationParameter, java.util.List<RequestParameter> globalRequestParameters, java.util.Map<org.springframework.http.HttpMethod,java.util.List<Response>> globalResponses, PathProvider pathProvider, java.util.List<SecurityContext> securityContexts, java.util.List<SecurityScheme> securitySchemes, java.util.List<AlternateTypeRule> alternateTypeRules, java.util.Comparator<ApiListingReference> listingReferenceOrdering, java.util.Comparator<ApiDescription> apiDescriptionOrdering, java.util.Comparator<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, java.util.Optional<java.lang.String> pathMapping, boolean isUriTemplatesEnabled, java.util.Set<com.fasterxml.classmate.ResolvedType> additionalModels, java.util.Set<Tag> tags, java.util.List<VendorExtension> vendorExtensions, java.util.List<Server> servers)

Method Summary

Modifier and Type	Method	Description
java.util.Set<com.fasterxml.classmate.ResolvedType>	getAdditionalModels()
AlternateTypeProvider	getAlternateTypeProvider()
java.util.Comparator<ApiDescription>	getApiDescriptionOrdering()
ApiInfo	getApiInfo()
ApiSelector	getApiSelector()
java.util.Set<java.lang.String>	getConsumes()
DocumentationType	getDocumentationType()
GenericTypeNamingStrategy	getGenericsNamingStrategy()
java.util.Collection<RequestParameter>	getGlobalParameters()
java.util.List<Parameter>	getGlobalRequestParameters()	Deprecated. use @see getGlobalParameters() instead
java.util.Map<org.springframework.web.bind.annotation.RequestMethod,java.util.List<ResponseMessage>>	getGlobalResponseMessages()
java.lang.String	getGroupName()
java.lang.String	getHost()
java.util.Set<java.lang.Class>	getIgnorableParameterTypes()
java.util.Comparator<ApiListingReference>	getListingReferenceOrdering()
java.util.Optional<java.lang.String>	getPathMapping()
PathProvider	getPathProvider()
java.util.Set<java.lang.String>	getProduces()
java.util.Set<java.lang.String>	getProtocols()
java.util.List<RequestHandler>	getRequestHandlers()
java.util.List<SecurityContext>	getSecurityContexts()
java.util.List<SecurityScheme>	getSecuritySchemes()
java.util.Collection<Server>	getServers()
java.util.Set<Tag>	getTags()
java.util.List<VendorExtension>	getVendorExtentions()
java.util.Collection<Response>	globalResponsesFor(org.springframework.http.HttpMethod method)
boolean	isUriTemplatesEnabled()
java.util.Comparator<Operation>	operationOrdering()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationContext

public DocumentationContext(DocumentationType documentationType,
                            java.util.List<RequestHandler> handlerMappings,
                            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<ResponseMessage>> globalResponseMessages,
                            java.util.List<Parameter> globalOperationParameter,
                            java.util.List<RequestParameter> globalRequestParameters,
                            java.util.Map<org.springframework.http.HttpMethod,java.util.List<Response>> globalResponses,
                            PathProvider pathProvider,
                            java.util.List<SecurityContext> securityContexts,
                            java.util.List<SecurityScheme> securitySchemes,
                            java.util.List<AlternateTypeRule> alternateTypeRules,
                            java.util.Comparator<ApiListingReference> listingReferenceOrdering,
                            java.util.Comparator<ApiDescription> apiDescriptionOrdering,
                            java.util.Comparator<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,
                            java.util.Optional<java.lang.String> pathMapping,
                            boolean isUriTemplatesEnabled,
                            java.util.Set<com.fasterxml.classmate.ResolvedType> additionalModels,
                            java.util.Set<Tag> tags,
                            java.util.List<VendorExtension> vendorExtensions,
                            java.util.List<Server> servers)

Method Detail

getDocumentationType

public DocumentationType getDocumentationType()

getRequestHandlers

public java.util.List<RequestHandler> getRequestHandlers()

getApiInfo

public ApiInfo getApiInfo()

getGroupName

public java.lang.String getGroupName()

getApiSelector

public ApiSelector getApiSelector()

getIgnorableParameterTypes

public java.util.Set<java.lang.Class> getIgnorableParameterTypes()

getGlobalResponseMessages

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

getGlobalRequestParameters

@Deprecated
public java.util.List<Parameter> getGlobalRequestParameters()

Deprecated.

use @see getGlobalParameters() instead

Returns:

list of parameters

getPathProvider

public PathProvider getPathProvider()

getSecurityContexts

public java.util.List<SecurityContext> getSecurityContexts()

getSecuritySchemes

public java.util.List<SecurityScheme> getSecuritySchemes()

getListingReferenceOrdering

public java.util.Comparator<ApiListingReference> getListingReferenceOrdering()

getApiDescriptionOrdering

public java.util.Comparator<ApiDescription> getApiDescriptionOrdering()

getAlternateTypeProvider

public AlternateTypeProvider getAlternateTypeProvider()

operationOrdering

public java.util.Comparator<Operation> operationOrdering()

getProduces

public java.util.Set<java.lang.String> getProduces()

getConsumes

public java.util.Set<java.lang.String> getConsumes()

getHost

public java.lang.String getHost()

getProtocols

public java.util.Set<java.lang.String> getProtocols()

getGenericsNamingStrategy

public GenericTypeNamingStrategy getGenericsNamingStrategy()

getPathMapping

public java.util.Optional<java.lang.String> getPathMapping()

isUriTemplatesEnabled

public boolean isUriTemplatesEnabled()

getAdditionalModels

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

getTags

public java.util.Set<Tag> getTags()

getVendorExtentions

public java.util.List<VendorExtension> getVendorExtentions()

getGlobalParameters

public java.util.Collection<RequestParameter> getGlobalParameters()

globalResponsesFor

public java.util.Collection<Response> globalResponsesFor(org.springframework.http.HttpMethod method)

getServers

public java.util.Collection<Server> getServers()