A B C D E F G H I K L M N O P Q R S T U V W
All Classes All Packages

A

addInputParam(ResolvedType) - Method in class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder

addInputParam(ResolvedType, Optional<ResolvedType>, Set<ResolvedType>) - Method in class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder

additionalIgnorableTypes(Set<Class>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

additionalModels(Set<ResolvedType>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

additionalOperationParameters(List<Parameter>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

additionalRequestParameters(List<RequestParameter>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

additionalResponseMessages(Map<RequestMethod, List<ResponseMessage>>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

additionalResponses(Map<HttpMethod, List<Response>>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

addReturn(ResolvedType) - Method in class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder

addReturn(ResolvedType, Optional<ResolvedType>) - Method in class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder

addRule(AlternateTypeRule) - Method in class springfox.documentation.spi.schema.AlternateTypeProvider

adjustedPath(String) - Method in interface springfox.documentation.service.PathAdjuster

alternateEvaluatedType() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

alternateFor(ResolvedType) - Method in class springfox.documentation.spi.schema.AlternateTypeProvider

alternateFor(ResolvedType) - Method in class springfox.documentation.spi.schema.contexts.ModelContext

alternateFor(ResolvedType) - Method in class springfox.documentation.spi.service.contexts.OperationContext

alternateFor(ResolvedType) - Method in class springfox.documentation.spi.service.contexts.ParameterContext

alternateFor(ResolvedType) - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

alternateFor(ResolvedType) - Method in class springfox.documentation.spi.service.contexts.ResponseContext

AlternateTypeProvider - Class in springfox.documentation.spi.schema

AlternateTypeProvider(List<AlternateTypeRule>) - Constructor for class springfox.documentation.spi.schema.AlternateTypeProvider

apiDescriptionBuilder() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

apiDescriptionOrdering() - Method in class springfox.documentation.spi.service.contexts.Defaults

apiDescriptionOrdering(Comparator<ApiDescription>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

apiInfo(ApiInfo) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

apiListingBuilder() - Method in class springfox.documentation.spi.service.contexts.ApiListingContext

ApiListingBuilderPlugin - Interface in springfox.documentation.spi.service

ApiListingContext - Class in springfox.documentation.spi.service.contexts

ApiListingContext(DocumentationType, ResourceGroup, ApiListingBuilder) - Constructor for class springfox.documentation.spi.service.contexts.ApiListingContext

apiListingReferenceOrdering() - Method in class springfox.documentation.spi.service.contexts.Defaults

apiListingReferenceOrdering(Comparator<ApiListingReference>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

ApiListingScannerPlugin - Interface in springfox.documentation.spi.service

apiPathCompatator() - Static method in class springfox.documentation.spi.service.contexts.Orderings

ApiSelector - Class in springfox.documentation.spi.service.contexts

ApiSelector(Predicate<RequestHandler>, Predicate<String>) - Constructor for class springfox.documentation.spi.service.contexts.ApiSelector

apply(ModelContext) - Method in interface springfox.documentation.spi.schema.ModelBuilderPlugin

Implement this method to override the @see springfox.documentation.schema.Model using the @see springfox .documentation.builders.ModelBuilder

apply(ModelPropertyContext) - Method in interface springfox.documentation.spi.schema.ModelPropertyBuilderPlugin

Implement this method to override the @see springfox.documentation.schema.ModelProperty using the @see springfox .documentation.builders.ModelPropertyBuilder

apply(ApiListingContext) - Method in interface springfox.documentation.spi.service.ApiListingBuilderPlugin

Implement this method to override the ApiListing using the ApiListingBuilder

apply(DocumentationContext) - Method in interface springfox.documentation.spi.service.ApiListingScannerPlugin

Implement this method to manually add ApiDescriptions

apply(DocumentationContextBuilder) - Method in interface springfox.documentation.spi.service.DefaultsProviderPlugin

Implement this method to override enrich the documentation context builder with documentation type specific defaults.

apply(OperationContext) - Method in interface springfox.documentation.spi.service.OperationBuilderPlugin

Implement this method to override the Operation using the OperationBuilder available in the context

apply(ParameterContext) - Method in interface springfox.documentation.spi.service.ParameterBuilderPlugin

Implement this method to collect input parameters and return values

apply(ParameterExpansionContext) - Method in interface springfox.documentation.spi.service.ExpandedParameterBuilderPlugin

Implement this method to override the Parameter using ParameterBuilder available in the context

apply(RequestMappingContext) - Method in interface springfox.documentation.spi.service.OperationModelsProviderPlugin

Implement this method to collect input parameters and return values

apply(ResponseContext) - Method in interface springfox.documentation.spi.service.ResponseBuilderPlugin

Implement this method to enrich return values

applyDefaultResponseMessages(boolean) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

B

build() - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

build() - Method in class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder

build() - Method in class springfox.documentation.spi.service.contexts.SecurityContextBuilder

builder() - Static method in class springfox.documentation.spi.service.contexts.SecurityContext

byOperationName() - Static method in class springfox.documentation.spi.service.contexts.Orderings

byPatternsCondition() - Static method in class springfox.documentation.spi.service.contexts.Orderings

byPluginName() - Static method in class springfox.documentation.spi.service.contexts.Orderings

byPluginType() - Static method in class springfox.documentation.spi.service.contexts.Orderings

C

canIgnore(ResolvedType) - Method in class springfox.documentation.spi.schema.contexts.ModelContext

combine(List<RequestHandler>) - Method in interface springfox.documentation.spi.service.RequestHandlerCombiner

configure(DocumentationContextBuilder) - Method in interface springfox.documentation.spi.service.DocumentationPlugin

Creates a documentation context based on a given DocumentationContextBuilder

consumes() - Method in class springfox.documentation.spi.service.contexts.OperationContext

consumes() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

consumes(Set<String>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

copy() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

copyPatternUsing(String) - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

create(DocumentationType) - Method in interface springfox.documentation.spi.service.DefaultsProviderPlugin

Deprecated.

create(ModelContext) - Method in interface springfox.documentation.spi.schema.SyntheticModelProviderPlugin

Creates a synthetic model

createModelSpecification(ModelContext) - Method in interface springfox.documentation.spi.schema.SyntheticModelProviderPlugin

Creates a synthetic model

D

decorator(PathContext) - Method in interface springfox.documentation.service.PathDecorator

DEFAULT - Static variable in class springfox.documentation.spi.service.contexts.ApiSelector

defaultExcludeAnnotations() - Method in class springfox.documentation.spi.service.contexts.Defaults

defaultIgnorableParameterTypes() - Method in class springfox.documentation.spi.service.contexts.Defaults

defaultResponseMessages() - Method in class springfox.documentation.spi.service.contexts.Defaults

Deprecated.

defaultResponseMessages(Map<RequestMethod, List<ResponseMessage>>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

Deprecated.

defaultResponses() - Method in class springfox.documentation.spi.service.contexts.Defaults

Default response messages set on all api operations

defaultResponses(Map<HttpMethod, List<Response>>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

defaultRules(TypeResolver) - Method in class springfox.documentation.spi.service.contexts.Defaults

Defaults - Class in springfox.documentation.spi.service.contexts

Defaults() - Constructor for class springfox.documentation.spi.service.contexts.Defaults

DefaultsProviderPlugin - Interface in springfox.documentation.spi.service

dependencies(ModelContext) - Method in interface springfox.documentation.spi.schema.SyntheticModelProviderPlugin

Creates a dependencies for the synthetic model

description() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

documentationContext() - Method in class springfox.documentation.spi.service.contexts.PathContext

DocumentationContext - Class in springfox.documentation.spi.service.contexts

DocumentationContext(DocumentationType, List<RequestHandler>, ApiInfo, String, ApiSelector, Set<Class>, Map<RequestMethod, List<ResponseMessage>>, List<Parameter>, List<RequestParameter>, Map<HttpMethod, List<Response>>, PathProvider, List<SecurityContext>, List<SecurityScheme>, List<AlternateTypeRule>, Comparator<ApiListingReference>, Comparator<ApiDescription>, Comparator<Operation>, Set<String>, Set<String>, String, Set<String>, GenericTypeNamingStrategy, Optional<String>, boolean, Set<ResolvedType>, Set<Tag>, List<VendorExtension>, List<Server>) - Constructor for class springfox.documentation.spi.service.contexts.DocumentationContext

DocumentationContextBuilder - Class in springfox.documentation.spi.service.contexts

DocumentationContextBuilder(DocumentationType) - Constructor for class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

DocumentationPlugin - Interface in springfox.documentation.spi.service

DocumentationType - Class in springfox.documentation.spi

DocumentationType(String, String) - Constructor for class springfox.documentation.spi.DocumentationType

DocumentationType(String, String, MediaType) - Constructor for class springfox.documentation.spi.DocumentationType

Creates a new instance of SimplePluginMetadata.

E

enableUrlTemplating(boolean) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

EnumTypeDeterminer - Interface in springfox.documentation.spi.schema

equals(Object) - Method in class springfox.documentation.spi.DocumentationType

equals(Object) - Method in class springfox.documentation.spi.schema.contexts.ModelContext

ExpandedParameterBuilderPlugin - Interface in springfox.documentation.spi.service

F

findAllAnnotations(Class<T>) - Method in class springfox.documentation.spi.service.contexts.OperationContext

findAnnotation(Class<A>) - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext

findAnnotation(Class<T>) - Method in class springfox.documentation.spi.service.contexts.OperationContext

findAnnotation(Class<T>) - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

findAnnotation(Class<T>) - Method in interface springfox.documentation.spi.service.ParameterMetadataAccessor

findAnnotations(Class<T>) - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

findControllerAnnotation(Class<T>) - Method in class springfox.documentation.spi.service.contexts.OperationContext

forHttpMethods(Predicate<HttpMethod>) - Method in class springfox.documentation.spi.service.contexts.SecurityContextBuilder

Deprecated.

forPaths(Predicate<String>) - Method in class springfox.documentation.spi.service.contexts.SecurityContextBuilder

Deprecated.

fromParent(ModelContext, ResolvedType) - Static method in class springfox.documentation.spi.schema.contexts.ModelContext

Convenience method to provide an new context for an input parameter

G

genericsNaming(GenericTypeNamingStrategy) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

GenericTypeNamingStrategy - Interface in springfox.documentation.spi.schema

Strategy to provide the strings used while naming generic types in the swagger output

getAdditionalModels() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getAdditionalModels() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

getAlternateTypeProvider() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

getAlternateTypeProvider() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getAlternateTypeProvider() - Method in class springfox.documentation.spi.service.contexts.OperationContext

getAlternateTypeProvider() - Method in class springfox.documentation.spi.service.contexts.ParameterContext

getAnnotatedElement() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext

getApiDescriptionOrdering() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getApiInfo() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getApiSelector() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getBeanPropertyDefinition() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext

getBuilder() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

Deprecated.

getBuilder() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext

Deprecated.

Use ModelPropertyContext.getSpecificationBuilder() instead

getCloseGeneric() - Method in interface springfox.documentation.spi.schema.GenericTypeNamingStrategy

getConsumes() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getDataTypeName() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext

getDocumentationContext() - Method in class springfox.documentation.spi.service.contexts.OperationContext

getDocumentationContext() - Method in class springfox.documentation.spi.service.contexts.ParameterContext

getDocumentationContext() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

getDocumentationContext() - Method in class springfox.documentation.spi.service.contexts.ResponseContext

getDocumentationType() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

getDocumentationType() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext

Documentation type this context supports, swagger 1.2, 2.0 or vanilla spring mvc

getDocumentationType() - Method in class springfox.documentation.spi.service.contexts.ApiListingContext

getDocumentationType() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getDocumentationType() - Method in class springfox.documentation.spi.service.contexts.OperationContext

getDocumentationType() - Method in class springfox.documentation.spi.service.contexts.ParameterContext

getDocumentationType() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext

getDocumentationType() - Method in class springfox.documentation.spi.service.contexts.ResponseContext

getDocumentationType() - Method in interface springfox.documentation.spi.service.DocumentationPlugin

getField() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext

Deprecated.

getFieldName() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext

getFieldName() - Method in interface springfox.documentation.spi.service.ParameterMetadataAccessor

getFieldType() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext

getFieldType() - Method in interface springfox.documentation.spi.service.ParameterMetadataAccessor

getGenericNamingStrategy() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

getGenericNamingStrategy() - Method in class springfox.documentation.spi.service.contexts.ParameterContext

getGenericsNamingStrategy() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getGenericsNamingStrategy() - Method in class springfox.documentation.spi.service.contexts.OperationContext

getGenericsNamingStrategy() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

getGlobalOperationParameters() - Method in class springfox.documentation.spi.service.contexts.OperationContext

Deprecated.

getGlobalParameters() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getGlobalRequestParameters() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

Deprecated.

use @see DocumentationContext.getGlobalParameters() instead

getGlobalRequestParameters() - Method in class springfox.documentation.spi.service.contexts.OperationContext

getGlobalResponseMessages() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getGlobalResponseMessages(String) - Method in class springfox.documentation.spi.service.contexts.OperationContext

getGroupName() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

getGroupName() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getGroupName() - Method in class springfox.documentation.spi.service.contexts.OperationContext

getGroupName() - Method in class springfox.documentation.spi.service.contexts.ParameterContext

getGroupName() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

getGroupName() - Method in class springfox.documentation.spi.service.contexts.ResponseContext

getGroupName() - Method in interface springfox.documentation.spi.service.DocumentationPlugin

Gets the group name for the plugin.

getHost() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getIgnorableParameterTypes() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getIgnorableParameterTypes() - Method in class springfox.documentation.spi.service.contexts.OperationContext

getIgnorableParameterTypes() - Method in class springfox.documentation.spi.service.contexts.ParameterContext

getIgnorableParameterTypes() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

getKnownModels() - Method in class springfox.documentation.spi.service.contexts.OperationContext

getListingReferenceOrdering() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getMediaType() - Method in class springfox.documentation.spi.DocumentationType

getMethodsCondition() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

getModelId() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

getModelMap() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

getModelSpecificationBuilder() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

getName() - Method in class springfox.documentation.spi.service.contexts.OperationContext

getName() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

getNames() - Method in interface springfox.documentation.spi.schema.UniqueTypeNameAdapter

Provides information about model names

getOpenGeneric() - Method in interface springfox.documentation.spi.schema.GenericTypeNamingStrategy

getOperationContext() - Method in class springfox.documentation.spi.service.contexts.ParameterContext

getOperationContext() - Method in class springfox.documentation.spi.service.contexts.ResponseContext

getOwner() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext

Owning model context

getParameterBuilder() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext

getParameterId() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

getParameters() - Method in class springfox.documentation.spi.service.contexts.OperationContext

getParameters() - Method in class springfox.documentation.spi.service.contexts.PathContext

getParameters() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

getParameterType() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext

getParentName() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext

getPathMapping() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getPathProvider() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getPathSelector() - Method in class springfox.documentation.spi.service.contexts.ApiSelector

getPatternsCondition() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

getProduces() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getProtocols() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getRequestHandlers() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getRequestHandlerSelector() - Method in class springfox.documentation.spi.service.contexts.ApiSelector

getRequestMappingPattern() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

getRequestParameterBuilder() - Method in class springfox.documentation.spi.service.contexts.ParameterExpansionContext

getRequestParameters() - Method in class springfox.documentation.spi.service.contexts.PathContext

getResolver() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext

getResourceGroup() - Method in class springfox.documentation.spi.service.contexts.ApiListingContext

getReturnType() - Method in class springfox.documentation.spi.service.contexts.OperationContext

getReturnType() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

getSecurityContexts() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getSecuritySchemes() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getServers() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getSpecificationBuilder() - Method in class springfox.documentation.spi.schema.contexts.ModelPropertyContext

Model property specification.

getTags() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getType() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

getTypeId() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

getTypeListDelimiter() - Method in interface springfox.documentation.spi.schema.GenericTypeNamingStrategy

getTypeName(String) - Method in interface springfox.documentation.spi.schema.UniqueTypeNameAdapter

Returns type for the model

getValidationGroups() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

getVendorExtentions() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

getView() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

globalResponsesFor(HttpMethod) - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

globalResponsesFor(HttpMethod) - Method in class springfox.documentation.spi.service.contexts.OperationContext

groupName(String) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

H

hashCode() - Method in class springfox.documentation.spi.DocumentationType

hashCode() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

hasRequestResponsePairs(ModelKey) - Method in interface springfox.documentation.spi.service.contexts.ModelSpecificationRegistry

hasSeenBefore(ResolvedType) - Method in class springfox.documentation.spi.schema.contexts.ModelContext

Answers the question, has the given type been processed?

headers() - Method in class springfox.documentation.spi.service.contexts.OperationContext

headers() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

host(String) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

httpMethod() - Method in class springfox.documentation.spi.service.contexts.OperationContext

I

inputParam(String, String, ResolvedType, Optional<ResolvedType>, Set<ResolvedType>, DocumentationType, AlternateTypeProvider, GenericTypeNamingStrategy, Set<Class>) - Static method in class springfox.documentation.spi.schema.contexts.ModelContext

Convenience method to provide an new context for an input parameter

isEnabled() - Method in interface springfox.documentation.spi.service.DocumentationPlugin

isEnum(Class<?>) - Method in interface springfox.documentation.spi.schema.EnumTypeDeterminer

isReturnType() - Method in class springfox.documentation.spi.schema.contexts.ModelContext

isUriTemplatesEnabled() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

K

key() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

L

listingPositionComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings

listingReferencePathComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings

M

methodComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings

methodParameter() - Method in class springfox.documentation.spi.service.contexts.ParameterContext

Deprecated.

Use ParameterContext.resolvedMethodParameter() instead

ModelBuilderPlugin - Interface in springfox.documentation.spi.schema

ModelContext - Class in springfox.documentation.spi.schema.contexts

modelKeys() - Method in interface springfox.documentation.spi.service.contexts.ModelSpecificationRegistry

modelNamesRegistry(ModelSpecificationRegistry) - Method in interface springfox.documentation.spi.service.ModelNamesRegistryFactoryPlugin

ModelNamesRegistryFactoryPlugin - Interface in springfox.documentation.spi.service

ModelPropertyBuilderPlugin - Interface in springfox.documentation.spi.schema

ModelPropertyContext - Class in springfox.documentation.spi.schema.contexts

ModelPropertyContext(ModelPropertyBuilder, BeanPropertyDefinition, TypeResolver, ModelContext, PropertySpecificationBuilder) - Constructor for class springfox.documentation.spi.schema.contexts.ModelPropertyContext

ModelPropertyContext(ModelPropertyBuilder, PropertySpecificationBuilder, AnnotatedElement, TypeResolver, ModelContext) - Constructor for class springfox.documentation.spi.schema.contexts.ModelPropertyContext

modelsDifferingOnlyInValidationGroups(ModelKey) - Method in interface springfox.documentation.spi.service.contexts.ModelSpecificationRegistry

modelSpecificationFor(ModelKey) - Method in interface springfox.documentation.spi.service.contexts.ModelSpecificationRegistry

ModelSpecificationRegistry - Interface in springfox.documentation.spi.service.contexts

modelsWithSameNameAndDifferentNamespace(ModelKey) - Method in interface springfox.documentation.spi.service.contexts.ModelSpecificationRegistry

N

nameFor(Class<?>) - Method in interface springfox.documentation.spi.schema.TypeNameProviderPlugin

Given a class name provides a name for it

nickNameComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings

O

OAS_30 - Static variable in class springfox.documentation.spi.DocumentationType

operationBuilder() - Method in class springfox.documentation.spi.service.contexts.OperationContext

OperationBuilderPlugin - Interface in springfox.documentation.spi.service

OperationContext - Class in springfox.documentation.spi.service.contexts

OperationContext(OperationBuilder, RequestMethod, RequestMappingContext, int) - Constructor for class springfox.documentation.spi.service.contexts.OperationContext

operationIndex() - Method in class springfox.documentation.spi.service.contexts.OperationContext

OperationModelContextsBuilder - Class in springfox.documentation.spi.service.contexts

OperationModelContextsBuilder(String, DocumentationType, String, AlternateTypeProvider, GenericTypeNamingStrategy, Set<Class>) - Constructor for class springfox.documentation.spi.service.contexts.OperationModelContextsBuilder

operationModelsBuilder() - Method in class springfox.documentation.spi.service.contexts.OperationContext

operationModelsBuilder() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

OperationModelsProviderPlugin - Interface in springfox.documentation.spi.service

operationOrdering() - Method in class springfox.documentation.spi.service.contexts.Defaults

operationOrdering() - Method in class springfox.documentation.spi.service.contexts.DocumentationContext

operationOrdering() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

operationOrdering(Comparator<Operation>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

operationSelector(Predicate<OperationContext>) - Method in class springfox.documentation.spi.service.contexts.SecurityContextBuilder

Orderings - Class in springfox.documentation.spi.service.contexts

P

parameterBuilder() - Method in class springfox.documentation.spi.service.contexts.ParameterContext

Deprecated.

ParameterBuilderPlugin - Interface in springfox.documentation.spi.service

ParameterContext - Class in springfox.documentation.spi.service.contexts

ParameterContext(ResolvedMethodParameter, DocumentationContext, GenericTypeNamingStrategy, OperationContext, int) - Constructor for class springfox.documentation.spi.service.contexts.ParameterContext

ParameterExpansionContext - Class in springfox.documentation.spi.service.contexts

ParameterExpansionContext(String, String, String, ParameterMetadataAccessor, DocumentationType, ParameterBuilder, RequestParameterBuilder) - Constructor for class springfox.documentation.spi.service.contexts.ParameterExpansionContext

ParameterMetadataAccessor - Interface in springfox.documentation.spi.service

params() - Method in class springfox.documentation.spi.service.contexts.OperationContext

params() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

PathAdjuster - Interface in springfox.documentation.service

PathContext - Class in springfox.documentation.spi.service.contexts

PathContext(RequestMappingContext, Optional<Operation>) - Constructor for class springfox.documentation.spi.service.contexts.PathContext

PathDecorator - Interface in springfox.documentation.service

Path decorator is useful to create transformations from a given path based on the RequestMappingContext.

pathMapping(Optional<String>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

pathProvider() - Method in class springfox.documentation.spi.service.contexts.PathContext

pathProvider(PathProvider) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

pluginOrdering() - Static method in class springfox.documentation.spi.service.contexts.Orderings

positionComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings

produces() - Method in class springfox.documentation.spi.service.contexts.OperationContext

produces() - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

produces(Set<String>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

properties(ModelContext) - Method in interface springfox.documentation.spi.schema.SyntheticModelProviderPlugin

Creates a synthetic model properties

propertySpecifications(ModelContext) - Method in interface springfox.documentation.spi.schema.SyntheticModelProviderPlugin

Creates a synthetic model properties

protocols(Set<String>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

Q

qualifiedMethodName(RequestMappingContext) - Static method in class springfox.documentation.spi.service.contexts.Orderings

qualifiedResourceGroupName(ResourceGroup) - Static method in class springfox.documentation.spi.service.contexts.Orderings

R

registerType(String, String) - Method in interface springfox.documentation.spi.schema.UniqueTypeNameAdapter

Add model name as is without adjusting

registerUniqueType(String, String) - Method in interface springfox.documentation.spi.schema.UniqueTypeNameAdapter

Register model name to keep it unique

RequestHandlerCombiner - Interface in springfox.documentation.spi.service

This is a class that knows how to combine a set of request handlers so that it doesnt drop "duplicates"

RequestHandlerProvider - Interface in springfox.documentation.spi.service

requestHandlers() - Method in interface springfox.documentation.spi.service.RequestHandlerProvider

requestHandlers(List<RequestHandler>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

RequestMappingContext - Class in springfox.documentation.spi.service.contexts

RequestMappingContext(String, DocumentationContext, RequestHandler) - Constructor for class springfox.documentation.spi.service.contexts.RequestMappingContext

requestMappingPattern() - Method in class springfox.documentation.spi.service.contexts.OperationContext

requestParameterBuilder() - Method in class springfox.documentation.spi.service.contexts.ParameterContext

resolvedMethodParameter() - Method in class springfox.documentation.spi.service.contexts.ParameterContext

resolvedType(TypeResolver) - Method in class springfox.documentation.spi.schema.contexts.ModelContext

resourceGroupComparator() - Static method in class springfox.documentation.spi.service.contexts.Orderings

responseBuilder() - Method in class springfox.documentation.spi.service.contexts.ResponseContext

ResponseBuilderPlugin - Interface in springfox.documentation.spi.service

ResponseContext - Class in springfox.documentation.spi.service.contexts

ResponseContext(DocumentationContext, OperationContext) - Constructor for class springfox.documentation.spi.service.contexts.ResponseContext

returnValue(String, String, ResolvedType, Optional<ResolvedType>, DocumentationType, AlternateTypeProvider, GenericTypeNamingStrategy, Set<Class>) - Static method in class springfox.documentation.spi.schema.contexts.ModelContext

Convenience method to provide an new context for an return parameter

ruleBuilders(List<Function<TypeResolver, AlternateTypeRule>>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

rules(List<AlternateTypeRule>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

S

securityContext() - Method in class springfox.documentation.spi.service.contexts.OperationContext

SecurityContext - Class in springfox.documentation.spi.service.contexts

A class to represent a default set of authorizations to apply to each api operation To customize which request mappings the list of authorizations are applied to Specify the custom includePatterns or requestMethods

SecurityContext(List<SecurityReference>, Predicate<String>, Predicate<HttpMethod>, Predicate<OperationContext>) - Constructor for class springfox.documentation.spi.service.contexts.SecurityContext

SecurityContextBuilder - Class in springfox.documentation.spi.service.contexts

SecurityContextBuilder() - Constructor for class springfox.documentation.spi.service.contexts.SecurityContextBuilder

securityContexts(List<SecurityContext>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

securityForOperation(OperationContext) - Method in class springfox.documentation.spi.service.contexts.SecurityContext

securityReferences(List<SecurityReference>) - Method in class springfox.documentation.spi.service.contexts.SecurityContextBuilder

securitySchemes(List<SecurityScheme>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

seen(ResolvedType) - Method in class springfox.documentation.spi.schema.contexts.ModelContext

selector(ApiSelector) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

servers(List<Server>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

setEqualityFor(String, String) - Method in interface springfox.documentation.spi.schema.UniqueTypeNameAdapter

Sets equality of two models to make sure, that models will be treated as one

SPRING_WEB - Static variable in class springfox.documentation.spi.DocumentationType

Deprecated.

springfox.documentation.service - package springfox.documentation.service

springfox.documentation.spi - package springfox.documentation.spi

springfox.documentation.spi.schema - package springfox.documentation.spi.schema

springfox.documentation.spi.schema.contexts - package springfox.documentation.spi.schema.contexts

springfox.documentation.spi.service - package springfox.documentation.spi.service

springfox.documentation.spi.service.contexts - package springfox.documentation.spi.service.contexts

SWAGGER_12 - Static variable in class springfox.documentation.spi.DocumentationType

SWAGGER_2 - Static variable in class springfox.documentation.spi.DocumentationType

SyntheticModelProviderPlugin - Interface in springfox.documentation.spi.schema

Plugin to generate custom models

T

tags(Set<Tag>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

TypeNameProviderPlugin - Interface in springfox.documentation.spi.schema

typeResolver(TypeResolver) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

U

UniqueTypeNameAdapter - Interface in springfox.documentation.spi.schema

V

vendorExtentions(List<VendorExtension>) - Method in class springfox.documentation.spi.service.contexts.DocumentationContextBuilder

viewFor(ResolvedMethodParameter) - Method in interface springfox.documentation.spi.schema.ViewProviderPlugin

Finds a active view for the parameter type

viewFor(OperationContext) - Method in interface springfox.documentation.spi.schema.ViewProviderPlugin

Finds a active view for the return type

viewFor(RequestMappingContext) - Method in interface springfox.documentation.spi.schema.ViewProviderPlugin

Finds a active view for the return type

ViewProviderPlugin - Interface in springfox.documentation.spi.schema

W

withKnownModels(Map<String, Set<Model>>) - Method in class springfox.documentation.spi.service.contexts.RequestMappingContext

A B C D E F G H I K L M N O P Q R S T U V W
All Classes All Packages