Class DocumentationContext


  • public class DocumentationContext
    extends java.lang.Object
    • 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

      • getRequestHandlers

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

        public ApiInfo getApiInfo()
      • getGroupName

        public java.lang.String getGroupName()
      • 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
      • 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()
      • 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()
      • 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()