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

A

addProperty(VendorExtension) - Method in class springfox.documentation.service.ObjectVendorExtension

addValidVendorExtensions(List<VendorExtension>) - Method in class springfox.documentation.service.SecurityScheme

AllowableListValues - Class in springfox.documentation.service

AllowableListValues(List<String>, String) - Constructor for class springfox.documentation.service.AllowableListValues

AllowableRangeValues - Class in springfox.documentation.service

AllowableRangeValues(String, String) - Constructor for class springfox.documentation.service.AllowableRangeValues

AllowableRangeValues(String, Boolean, String, Boolean) - Constructor for class springfox.documentation.service.AllowableRangeValues

allowableValues(AllowableValues) - Method in class springfox.documentation.builders.ModelPropertyBuilder

allowableValues(AllowableValues) - Method in class springfox.documentation.builders.ParameterBuilder

Updates if the parameter is bound by a range of values or a range of numerical values

allowableValues(Class<?>) - Static method in class springfox.documentation.schema.Enums

AllowableValues - Interface in springfox.documentation.service

allowEmptyValue(Boolean) - Method in class springfox.documentation.builders.ModelPropertyBuilder

Support for isAllowEmpty value

allowEmptyValue(Boolean) - Method in class springfox.documentation.builders.ParameterBuilder

Updates the flag that allows sending empty values for this parameter

allowMultiple(boolean) - Method in class springfox.documentation.builders.ParameterBuilder

Updates if the parameter should allow multiple values

alternate - Variable in class springfox.documentation.schema.AlternateTypeRule

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

Provides alternate for supplier type.

AlternateTypeBuilder - Class in springfox.documentation.builders

AlternateTypeBuilder() - Constructor for class springfox.documentation.builders.AlternateTypeBuilder

AlternateTypePropertyBuilder - Class in springfox.documentation.builders

AlternateTypePropertyBuilder() - Constructor for class springfox.documentation.builders.AlternateTypePropertyBuilder

AlternateTypeRule - Class in springfox.documentation.schema

AlternateTypeRule(ResolvedType, ResolvedType) - Constructor for class springfox.documentation.schema.AlternateTypeRule

Instantiates a new Alternate type rule.

AlternateTypeRule(ResolvedType, ResolvedType, int) - Constructor for class springfox.documentation.schema.AlternateTypeRule

Instantiates a new Alternate type rule.

AlternateTypeRuleConvention - Interface in springfox.documentation.schema

AlternateTypeRules - Class in springfox.documentation.schema

annotate(Annotation) - Method in class springfox.documentation.service.ResolvedMethodParameter

ant(String) - Static method in class springfox.documentation.builders.PathSelectors

Predicate that evaluates the supplied ant pattern

any() - Static method in class springfox.documentation.builders.PathSelectors

Any path satisfies this condition

any() - Static method in class springfox.documentation.builders.RequestHandlerSelectors

Any RequestHandler satisfies this condition

ApiDescription - Class in springfox.documentation.service

ApiDescription(String, String, List<Operation>, Boolean) - Constructor for class springfox.documentation.service.ApiDescription

Deprecated.

@since 2.8.1

ApiDescription(String, String, String, List<Operation>, Boolean) - Constructor for class springfox.documentation.service.ApiDescription

ApiDescriptionBuilder - Class in springfox.documentation.builders

ApiDescriptionBuilder(Ordering<Operation>) - Constructor for class springfox.documentation.builders.ApiDescriptionBuilder

ApiIgnore - Annotation Type in springfox.documentation.annotations

ApiInfo - Class in springfox.documentation.service

ApiInfo(String, String, String, String, String, String, String) - Constructor for class springfox.documentation.service.ApiInfo

Deprecated.

@since 2.4.0

ApiInfo(String, String, String, String, Contact, String, String, Collection<VendorExtension>) - Constructor for class springfox.documentation.service.ApiInfo

Default contstructor

ApiInfoBuilder - Class in springfox.documentation.builders

Builds the api information

ApiInfoBuilder() - Constructor for class springfox.documentation.builders.ApiInfoBuilder

ApiKey - Class in springfox.documentation.service

ApiKey(String, String, String) - Constructor for class springfox.documentation.service.ApiKey

ApiKey(String, String, String, List<VendorExtension>) - Constructor for class springfox.documentation.service.ApiKey

ApiListing - Class in springfox.documentation.service

ApiListing(String, String, String, Set<String>, Set<String>, String, Set<String>, List<SecurityReference>, List<ApiDescription>, Map<String, Model>, String, int, Set<Tag>) - Constructor for class springfox.documentation.service.ApiListing

ApiListingBuilder - Class in springfox.documentation.builders

ApiListingBuilder(Ordering<ApiDescription>) - Constructor for class springfox.documentation.builders.ApiListingBuilder

Update the sorting order for api descriptions

ApiListingReference - Class in springfox.documentation.service

ApiListingReference(String, String, int) - Constructor for class springfox.documentation.service.ApiListingReference

apiListingsByResourceGroupName(Multimap<String, ApiListing>) - Method in class springfox.documentation.builders.DocumentationBuilder

Updates the map with new entries

apis(List<ApiDescription>) - Method in class springfox.documentation.builders.ApiListingBuilder

Updates the apis

apis(List<ApiListingReference>) - Method in class springfox.documentation.builders.ResourceListingBuilder

Updates the api listed within this resource listing

apiVersion(String) - Method in class springfox.documentation.builders.ApiListingBuilder

Updates the api version

apiVersion(String) - Method in class springfox.documentation.builders.ResourceListingBuilder

Updates the api version

appendConsumes(List<String>) - Method in class springfox.documentation.builders.ApiListingBuilder

Appends to the exiting collection of supported media types this listing consumes

appendProduces(List<String>) - Method in class springfox.documentation.builders.ApiListingBuilder

Appends to the exiting collection of supported media types this listing produces

appliesTo(ResolvedType) - Method in class springfox.documentation.schema.AlternateTypeRule

Check if an alternate applies to type.

apply(DynamicType.Builder<Object>) - Method in class springfox.documentation.builders.AlternateTypePropertyBuilder

attribute(Boolean) - Method in class springfox.documentation.schema.Xml

AuthorizationCodeGrant - Class in springfox.documentation.service

AuthorizationCodeGrant(TokenRequestEndpoint, TokenEndpoint) - Constructor for class springfox.documentation.service.AuthorizationCodeGrant

AuthorizationCodeGrantBuilder - Class in springfox.documentation.builders

AuthorizationCodeGrantBuilder() - Constructor for class springfox.documentation.builders.AuthorizationCodeGrantBuilder

authorizations(Collection<SecurityReference>) - Method in class springfox.documentation.builders.OperationBuilder

Updates the security checks that apply to this operation

AuthorizationScope - Class in springfox.documentation.service

AuthorizationScope(String, String) - Constructor for class springfox.documentation.service.AuthorizationScope

AuthorizationScopeBuilder - Class in springfox.documentation.builders

AuthorizationScopeBuilder() - Constructor for class springfox.documentation.builders.AuthorizationScopeBuilder

availableTags(Set<Tag>) - Method in class springfox.documentation.builders.ApiListingBuilder

Globally configured tags

B

baseModel(String) - Method in class springfox.documentation.builders.ModelBuilder

Update the based model

basePackage(String) - Static method in class springfox.documentation.builders.RequestHandlerSelectors

Predicate that matches RequestHandler with given base package name for the class of the handler method.

basePath(String) - Method in class springfox.documentation.builders.ApiListingBuilder

Updates base path for the api listing

basePath(String) - Method in class springfox.documentation.builders.DocumentationBuilder

Base path for this API

BasicAuth - Class in springfox.documentation.service

BasicAuth(String) - Constructor for class springfox.documentation.service.BasicAuth

BasicAuth(String, List<VendorExtension>) - Constructor for class springfox.documentation.service.BasicAuth

build() - Method in class springfox.documentation.builders.AlternateTypeBuilder

build() - Method in class springfox.documentation.builders.ApiDescriptionBuilder

build() - Method in class springfox.documentation.builders.ApiInfoBuilder

build() - Method in class springfox.documentation.builders.ApiListingBuilder

build() - Method in class springfox.documentation.builders.AuthorizationCodeGrantBuilder

build() - Method in class springfox.documentation.builders.AuthorizationScopeBuilder

build() - Method in class springfox.documentation.builders.DocumentationBuilder

build() - Method in class springfox.documentation.builders.ImplicitGrantBuilder

build() - Method in class springfox.documentation.builders.LoginEndpointBuilder

build() - Method in class springfox.documentation.builders.ModelBuilder

build() - Method in class springfox.documentation.builders.ModelPropertyBuilder

build() - Method in class springfox.documentation.builders.OAuthBuilder

build() - Method in class springfox.documentation.builders.OperationBuilder

build() - Method in class springfox.documentation.builders.ParameterBuilder

build() - Method in class springfox.documentation.builders.ResourceListingBuilder

build() - Method in class springfox.documentation.builders.ResponseMessageBuilder

build() - Method in class springfox.documentation.builders.TokenEndpointBuilder

build() - Method in class springfox.documentation.builders.TokenRequestEndpointBuilder

build() - Method in class springfox.documentation.service.SecurityReference.SecurityReferenceBuilder

builder() - Static method in class springfox.documentation.service.SecurityReference

BuilderDefaults - Class in springfox.documentation.builders

This is a utility class with useful methods for builders

byListingPosition() - Static method in class springfox.documentation.builders.DocumentationBuilder

C

Cacheable - Annotation Type in springfox.documentation.annotations

Annotation indicating that a method (or all the methods on a class) can be cached.

classByName(String) - Static method in class springfox.documentation.schema.ClassSupport

ClassSupport - Class in springfox.documentation.schema

ClientCredentialsGrant - Class in springfox.documentation.service

ClientCredentialsGrant(String) - Constructor for class springfox.documentation.service.ClientCredentialsGrant

clientIdName(String) - Method in class springfox.documentation.builders.TokenRequestEndpointBuilder

Updates the client id name

clientSecretName(String) - Method in class springfox.documentation.builders.TokenRequestEndpointBuilder

Updates the client secret name

code(int) - Method in class springfox.documentation.builders.ResponseMessageBuilder

Updates the http response code

codegenMethodNameStem(String) - Method in class springfox.documentation.builders.OperationBuilder

This is an optional override that provides a custom method name stem, such that the method name that is generated for the purposes of code-gen can be customized.

collectionFormat(String) - Method in class springfox.documentation.builders.ParameterBuilder

Updates the parameter extensions

combine(RequestHandler) - Method in interface springfox.documentation.RequestHandler

This is to merge two request handlers that are indistinguishable other than the media types supported

complexExamples(Multimap<String, Example>) - Method in class springfox.documentation.builders.ParameterBuilder

consumes(Set<String>) - Method in class springfox.documentation.builders.ApiListingBuilder

Replaces the existing media types with new entries that this documentation consumes

consumes(Set<String>) - Method in class springfox.documentation.builders.DocumentationBuilder

Updates the existing media types with new entries that this documentation consumes

consumes(Set<String>) - Method in class springfox.documentation.builders.OperationBuilder

Updates the existing media types with new entries that this documentation consumes

consumes() - Method in interface springfox.documentation.RequestHandler

contact(String) - Method in class springfox.documentation.builders.ApiInfoBuilder

Deprecated.

@since 2.4.0. Use the overload that takes in a contact instead

contact(Contact) - Method in class springfox.documentation.builders.ApiInfoBuilder

Updates contact information for the person responsible for this API

Contact - Class in springfox.documentation.service

Contact(String, String, String) - Constructor for class springfox.documentation.service.Contact

CredentialsGrant - Class in springfox.documentation.service

CredentialsGrant(String, String) - Constructor for class springfox.documentation.service.CredentialsGrant

D

declaringClass() - Method in interface springfox.documentation.RequestHandler

Deprecated.

@since 2.7.0 This is introduced to preserve backwards compat with groups

DEFAULT - Static variable in class springfox.documentation.service.ApiInfo

DEFAULT_CONTACT - Static variable in class springfox.documentation.service.ApiInfo

DEFAULT_PRECEDENCE - Static variable in class springfox.documentation.service.Parameter

defaultIfAbsent(T, T) - Static method in class springfox.documentation.builders.BuilderDefaults

Returns this default value if the new value is null

defaultName() - Method in class springfox.documentation.service.ResolvedMethodParameter

defaultValue(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder

defaultValue(String) - Method in class springfox.documentation.builders.ParameterBuilder

Updates the default value of the parameter

deprecated(String) - Method in class springfox.documentation.builders.OperationBuilder

Marks the listing as deprecated

description(String) - Method in class springfox.documentation.builders.ApiDescriptionBuilder

Updates the descriptions to the api operation

description(String) - Method in class springfox.documentation.builders.ApiInfoBuilder

Updates the api description

description(String) - Method in class springfox.documentation.builders.ApiListingBuilder

Updates the description

description(String) - Method in class springfox.documentation.builders.AuthorizationScopeBuilder

Updates the description of the scope

description(String) - Method in class springfox.documentation.builders.ModelBuilder

Update the description of the model

description(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder

description(String) - Method in class springfox.documentation.builders.ParameterBuilder

Updates the description of the parameter

descriptor(Map<String, Tag>, String) - Static method in class springfox.documentation.service.Tags

DIRECT_SUBSTITUTION_RULE_ORDER - Static variable in class springfox.documentation.schema.AlternateTypeRules

discriminator(String) - Method in class springfox.documentation.builders.ModelBuilder

Updates inheritance discriminator, used to identify inherited subclasses.

Documentation - Class in springfox.documentation.service

Documentation(String, String, Set<Tag>, Multimap<String, ApiListing>, ResourceListing, Set<String>, Set<String>, String, Set<String>, Collection<VendorExtension>) - Constructor for class springfox.documentation.service.Documentation

DocumentationBuilder - Class in springfox.documentation.builders

DocumentationBuilder() - Constructor for class springfox.documentation.builders.DocumentationBuilder

E

emptyListValuesToNull(AllowableListValues) - Static method in class springfox.documentation.schema.Enums

emptyTags() - Static method in class springfox.documentation.service.Tags

emptyToNull(AllowableValues, AllowableValues) - Static method in class springfox.documentation.builders.BuilderDefaults

Retains current allowable values if then new value is null

Entry<K,V> - Class in springfox.documentation.schema

Entry() - Constructor for class springfox.documentation.schema.Entry

Enums - Class in springfox.documentation.schema

equals(Object) - Method in class springfox.documentation.RequestHandlerKey

equals(Object) - Method in class springfox.documentation.schema.Xml

equals(Object) - Method in class springfox.documentation.service.Header

equals(Object) - Method in class springfox.documentation.service.ObjectVendorExtension

equals(Object) - Method in class springfox.documentation.service.ResourceGroup

equals(Object) - Method in class springfox.documentation.service.ResponseMessage

equals(Object) - Method in class springfox.documentation.service.StringVendorExtension

equals(Object) - Method in class springfox.documentation.service.Tag

exactMatch(ResolvedType, ResolvedType) - Static method in class springfox.documentation.schema.WildcardType

example(String) - Method in class springfox.documentation.builders.ModelBuilder

Deprecated.

@since 2.8.1 Use the one which takes in an Object instead

example(Object) - Method in class springfox.documentation.builders.ModelBuilder

Updates the Example for the model

example(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder

Deprecated.

@since 2.8.1 Use the one with Object as parameter

example(Object) - Method in class springfox.documentation.builders.ModelPropertyBuilder

Updates the example

Example - Class in springfox.documentation.schema

Example(Object) - Constructor for class springfox.documentation.schema.Example

Example(String, Object) - Constructor for class springfox.documentation.schema.Example

extensions(List<VendorExtension>) - Method in class springfox.documentation.builders.ApiInfoBuilder

Adds extensions for this API

extensions(List<VendorExtension>) - Method in class springfox.documentation.builders.DocumentationBuilder

Adds extensions for this API

extensions(List<VendorExtension>) - Method in class springfox.documentation.builders.ModelPropertyBuilder

extensions(List<VendorExtension>) - Method in class springfox.documentation.builders.OperationBuilder

Updates the operation extensions

F

findAnnotation(Class<T>) - Method in interface springfox.documentation.RequestHandler

findAnnotation(Class<T>) - Method in class springfox.documentation.service.ResolvedMethodParameter

findControllerAnnotation(Class<T>) - Method in interface springfox.documentation.RequestHandler

fullyQualifiedClassName(String) - Method in class springfox.documentation.builders.AlternateTypeBuilder

G

GENERIC_SUBSTITUTION_RULE_ORDER - Static variable in class springfox.documentation.schema.AlternateTypeRules

getAllowableValues() - Method in class springfox.documentation.schema.ModelProperty

getAllowableValues() - Method in class springfox.documentation.schema.ModelRef

getAllowableValues() - Method in interface springfox.documentation.schema.ModelReference

getAllowableValues() - Method in class springfox.documentation.service.Parameter

getAnnotations() - Method in class springfox.documentation.service.ResolvedMethodParameter

getApiListings() - Method in class springfox.documentation.service.Documentation

getApis() - Method in class springfox.documentation.service.ApiListing

getApis() - Method in class springfox.documentation.service.ResourceListing

getApiVersion() - Method in class springfox.documentation.service.ApiListing

getApiVersion() - Method in class springfox.documentation.service.ResourceListing

getApplicationBasePath() - Method in interface springfox.documentation.PathProvider

Gets the application base path

getAttribute() - Method in class springfox.documentation.schema.Xml

getBaseModel() - Method in class springfox.documentation.schema.Model

getBasePath() - Method in class springfox.documentation.service.ApiListing

getBasePath() - Method in class springfox.documentation.service.Documentation

getClientIdName() - Method in class springfox.documentation.service.TokenRequestEndpoint

getClientSecretName() - Method in class springfox.documentation.service.TokenRequestEndpoint

getCode() - Method in class springfox.documentation.service.ResponseMessage

getCollectionFormat() - Method in class springfox.documentation.service.Parameter

getConsumes() - Method in class springfox.documentation.service.ApiListing

getConsumes() - Method in class springfox.documentation.service.Documentation

getConsumes() - Method in class springfox.documentation.service.Operation

getContact() - Method in class springfox.documentation.service.ApiInfo

getControllerClass() - Method in class springfox.documentation.service.ResourceGroup

getDefaultValue() - Method in class springfox.documentation.schema.ModelProperty

getDefaultValue() - Method in class springfox.documentation.service.Parameter

getDeprecated() - Method in class springfox.documentation.service.Operation

getDescription() - Method in class springfox.documentation.schema.Model

getDescription() - Method in class springfox.documentation.schema.ModelProperty

getDescription() - Method in class springfox.documentation.service.ApiDescription

getDescription() - Method in class springfox.documentation.service.ApiInfo

getDescription() - Method in class springfox.documentation.service.ApiListing

getDescription() - Method in class springfox.documentation.service.ApiListingReference

getDescription() - Method in class springfox.documentation.service.AuthorizationScope

getDescription() - Method in class springfox.documentation.service.Header

getDescription() - Method in class springfox.documentation.service.Parameter

getDescription() - Method in class springfox.documentation.service.Tag

getDiscriminator() - Method in class springfox.documentation.schema.Model

getEmail() - Method in class springfox.documentation.service.Contact

getExample() - Method in class springfox.documentation.schema.Model

getExample() - Method in class springfox.documentation.schema.ModelProperty

getExamples() - Method in class springfox.documentation.service.Parameter

getExclusiveMax() - Method in class springfox.documentation.service.AllowableRangeValues

getExclusiveMin() - Method in class springfox.documentation.service.AllowableRangeValues

getGrantTypes() - Method in class springfox.documentation.service.OAuth

getGroupName() - Method in class springfox.documentation.service.ApiDescription

getGroupName() - Method in class springfox.documentation.service.Documentation

getGroupName() - Method in class springfox.documentation.service.ResourceGroup

getHandlerMethod() - Method in interface springfox.documentation.RequestHandler

Deprecated.

This is introduced to preserve backwards compat

getHeaders() - Method in class springfox.documentation.service.ResponseMessage

getHost() - Method in class springfox.documentation.service.ApiListing

getHost() - Method in class springfox.documentation.service.Documentation

getId() - Method in class springfox.documentation.schema.Model

getInfo() - Method in class springfox.documentation.service.ResourceListing

getItemType() - Method in class springfox.documentation.schema.ModelRef

getItemType() - Method in interface springfox.documentation.schema.ModelReference

getKey() - Method in class springfox.documentation.schema.Entry

getKeyname() - Method in class springfox.documentation.service.ApiKey

getLicense() - Method in class springfox.documentation.service.ApiInfo

getLicenseUrl() - Method in class springfox.documentation.service.ApiInfo

getLoginEndpoint() - Method in class springfox.documentation.service.ImplicitGrant

getMax() - Method in class springfox.documentation.service.AllowableRangeValues

getMediaType() - Method in class springfox.documentation.schema.Example

getMessage() - Method in class springfox.documentation.service.ResponseMessage

getMethod() - Method in class springfox.documentation.service.Operation

getMin() - Method in class springfox.documentation.service.AllowableRangeValues

getModelRef() - Method in class springfox.documentation.schema.ModelProperty

getModelRef() - Method in class springfox.documentation.service.Parameter

getModelReference() - Method in class springfox.documentation.service.Header

getModels() - Method in class springfox.documentation.service.ApiListing

getName() - Method in interface springfox.documentation.RequestHandler

getName() - Method in class springfox.documentation.schema.Model

getName() - Method in class springfox.documentation.schema.ModelProperty

getName() - Method in class springfox.documentation.schema.Xml

getName() - Method in class springfox.documentation.service.Contact

getName() - Method in class springfox.documentation.service.Header

getName() - Method in class springfox.documentation.service.ListVendorExtension

getName() - Method in class springfox.documentation.service.ObjectVendorExtension

getName() - Method in class springfox.documentation.service.Parameter

getName() - Method in class springfox.documentation.service.SecurityScheme

getName() - Method in class springfox.documentation.service.StringVendorExtension

getName() - Method in class springfox.documentation.service.Tag

getName() - Method in interface springfox.documentation.service.VendorExtension

getNamespace() - Method in class springfox.documentation.schema.Xml

getNotes() - Method in class springfox.documentation.service.Operation

getOperationPath(String) - Method in interface springfox.documentation.PathProvider

Gets the sanitized and prepended with a "/" operation path

getOperations() - Method in class springfox.documentation.service.ApiDescription

getOrder() - Method in class springfox.documentation.schema.AlternateTypeRule

getOrder() - Method in class springfox.documentation.service.Parameter

getOrder() - Method in class springfox.documentation.service.Tag

getParamAccess() - Method in class springfox.documentation.service.Parameter

getParameterIndex() - Method in class springfox.documentation.service.ResolvedMethodParameter

getParameters() - Method in interface springfox.documentation.RequestHandler

getParameters() - Method in class springfox.documentation.service.Operation

getParameterType() - Method in class springfox.documentation.service.ResolvedMethodParameter

getParamType() - Method in class springfox.documentation.service.Parameter

getPassAs() - Method in class springfox.documentation.service.ApiKey

getPath() - Method in class springfox.documentation.service.ApiDescription

getPath() - Method in class springfox.documentation.service.ApiListingReference

getPathMappings() - Method in class springfox.documentation.RequestHandlerKey

getPattern() - Method in class springfox.documentation.schema.ModelProperty

getPattern() - Method in class springfox.documentation.service.Parameter

getPatternsCondition() - Method in interface springfox.documentation.RequestHandler

getPosition() - Method in class springfox.documentation.schema.ModelProperty

getPosition() - Method in class springfox.documentation.service.ApiListing

getPosition() - Method in class springfox.documentation.service.ApiListingReference

getPosition() - Method in class springfox.documentation.service.Operation

getPosition() - Method in class springfox.documentation.service.ResourceGroup

getPrefix() - Method in class springfox.documentation.schema.Xml

getProduces() - Method in class springfox.documentation.service.ApiListing

getProduces() - Method in class springfox.documentation.service.Documentation

getProduces() - Method in class springfox.documentation.service.Operation

getProducibleMediaTypes() - Method in class springfox.documentation.RequestHandlerKey

getProperties() - Method in class springfox.documentation.schema.Model

getProtocol() - Method in class springfox.documentation.service.Operation

getProtocols() - Method in class springfox.documentation.service.ApiListing

getQualifiedType() - Method in class springfox.documentation.schema.Model

getQualifiedType() - Method in class springfox.documentation.schema.ModelProperty

getReference() - Method in class springfox.documentation.service.SecurityReference

getRequestMapping() - Method in interface springfox.documentation.RequestHandler

Deprecated.

This is introduced to preserve backwards compat

getResourceListing() - Method in class springfox.documentation.service.Documentation

getResourceListingPath(String, String) - Method in interface springfox.documentation.PathProvider

Gets the resource listing path given a group name and api

getResourcePath() - Method in class springfox.documentation.service.ApiListing

getResponseMessages() - Method in class springfox.documentation.service.Operation

getResponseModel() - Method in class springfox.documentation.service.Operation

getResponseModel() - Method in class springfox.documentation.service.ResponseMessage

getReturnType() - Method in interface springfox.documentation.RequestHandler

getScalarExample() - Method in class springfox.documentation.service.Parameter

getSchemes() - Method in class springfox.documentation.service.Documentation

getScope() - Method in class springfox.documentation.service.AuthorizationScope

getScopes() - Method in class springfox.documentation.service.OAuth

getScopes() - Method in class springfox.documentation.service.SecurityReference

getSecurityReferences() - Method in class springfox.documentation.service.ApiListing

getSecurityReferences() - Method in class springfox.documentation.service.Operation

getSecuritySchemes() - Method in class springfox.documentation.service.ResourceListing

getSubTypes() - Method in class springfox.documentation.schema.Model

getSummary() - Method in class springfox.documentation.service.Operation

getSupportedMediaTypes() - Method in class springfox.documentation.RequestHandlerKey

getSupportedMethods() - Method in class springfox.documentation.RequestHandlerKey

getTags() - Method in class springfox.documentation.service.ApiListing

getTags() - Method in class springfox.documentation.service.Documentation

getTags() - Method in class springfox.documentation.service.Operation

getTermsOfServiceUrl() - Method in class springfox.documentation.service.ApiInfo

getTitle() - Method in class springfox.documentation.service.ApiInfo

getTokenEndpoint() - Method in class springfox.documentation.service.AuthorizationCodeGrant

getTokenName() - Method in class springfox.documentation.service.ImplicitGrant

getTokenName() - Method in class springfox.documentation.service.TokenEndpoint

getTokenRequestEndpoint() - Method in class springfox.documentation.service.AuthorizationCodeGrant

getTokenUrl() - Method in class springfox.documentation.service.CredentialsGrant

getType() - Method in class springfox.documentation.schema.Model

getType() - Method in class springfox.documentation.schema.ModelProperty

getType() - Method in class springfox.documentation.schema.ModelRef

getType() - Method in interface springfox.documentation.schema.ModelReference

getType() - Method in class springfox.documentation.service.GrantType

getType() - Method in class springfox.documentation.service.Parameter

getType() - Method in class springfox.documentation.service.SecurityScheme

getUniqueId() - Method in class springfox.documentation.service.Operation

getUrl() - Method in class springfox.documentation.service.Contact

getUrl() - Method in class springfox.documentation.service.LoginEndpoint

getUrl() - Method in class springfox.documentation.service.TokenEndpoint

getUrl() - Method in class springfox.documentation.service.TokenRequestEndpoint

getValue() - Method in class springfox.documentation.schema.Example

getValue() - Method in class springfox.documentation.service.ListVendorExtension

getValue() - Method in class springfox.documentation.service.ObjectVendorExtension

getValue() - Method in class springfox.documentation.service.StringVendorExtension

getValue() - Method in interface springfox.documentation.service.VendorExtension

getValues() - Method in class springfox.documentation.service.AllowableListValues

getValueType() - Method in class springfox.documentation.service.AllowableListValues

getVendorExtensions() - Method in class springfox.documentation.schema.ModelProperty

getVendorExtensions() - Method in class springfox.documentation.service.ApiInfo

getVendorExtensions() - Method in class springfox.documentation.service.Documentation

getVendorExtensions() - Method in class springfox.documentation.service.Operation

getVendorExtensions() - Method in class springfox.documentation.service.ResponseMessage

getVendorExtensions() - Method in class springfox.documentation.service.SecurityScheme

getVendorExtensions() - Method in class springfox.documentation.service.Tag

getVendorExtentions() - Method in class springfox.documentation.service.Parameter

getVersion() - Method in class springfox.documentation.service.ApiInfo

getWrapped() - Method in class springfox.documentation.schema.Xml

getXml() - Method in class springfox.documentation.schema.Model

getXml() - Method in class springfox.documentation.schema.ModelProperty

GrantType - Class in springfox.documentation.service

GrantType(String) - Constructor for class springfox.documentation.service.GrantType

grantTypes(List<GrantType>) - Method in class springfox.documentation.builders.OAuthBuilder

Updates the grant types that this security definition represents

groupName(String) - Method in class springfox.documentation.builders.ApiDescriptionBuilder

Updates the group name the api operation belongs to

groupName() - Method in interface springfox.documentation.RequestHandler

H

hashCode() - Method in class springfox.documentation.RequestHandlerKey

hashCode() - Method in class springfox.documentation.schema.Xml

hashCode() - Method in class springfox.documentation.service.Header

hashCode() - Method in class springfox.documentation.service.ObjectVendorExtension

hashCode() - Method in class springfox.documentation.service.ResourceGroup

hashCode() - Method in class springfox.documentation.service.ResponseMessage

hashCode() - Method in class springfox.documentation.service.StringVendorExtension

hashCode() - Method in class springfox.documentation.service.Tag

hasParameterAnnotation(Class<? extends Annotation>) - Method in class springfox.documentation.service.ResolvedMethodParameter

hasParameterAnnotations() - Method in class springfox.documentation.service.ResolvedMethodParameter

hasWildcards(ResolvedType) - Static method in class springfox.documentation.schema.WildcardType

Header - Class in springfox.documentation.service

Header(String, String, ModelReference) - Constructor for class springfox.documentation.service.Header

headers(Map<String, ModelReference>) - Method in class springfox.documentation.builders.ResponseMessageBuilder

Deprecated.

Use the ResponseMessageBuilder.headersWithDescription(java.util.Map<java.lang.String, springfox.documentation.service.Header>) instead

headers() - Method in interface springfox.documentation.RequestHandler

headersWithDescription(Map<String, Header>) - Method in class springfox.documentation.builders.ResponseMessageBuilder

Updates the response headers

hidden(boolean) - Method in class springfox.documentation.builders.ApiDescriptionBuilder

Marks the operation as hidden

hidden(boolean) - Method in class springfox.documentation.builders.OperationBuilder

Marks the operation as hidden

hidden(boolean) - Method in class springfox.documentation.builders.ParameterBuilder

Updates if the parameter is hidden

host(String) - Method in class springfox.documentation.builders.ApiListingBuilder

Updates the host

host(String) - Method in class springfox.documentation.builders.DocumentationBuilder

Updates the host (name or ip) serving this api.

I

id(String) - Method in class springfox.documentation.builders.ModelBuilder

Updates the Id of the model, usually the type name

ImplicitGrant - Class in springfox.documentation.service

ImplicitGrant(LoginEndpoint, String) - Constructor for class springfox.documentation.service.ImplicitGrant

ImplicitGrantBuilder - Class in springfox.documentation.builders

ImplicitGrantBuilder() - Constructor for class springfox.documentation.builders.ImplicitGrantBuilder

Incubating - Annotation Type in springfox.documentation.annotations

info(ApiInfo) - Method in class springfox.documentation.builders.ResourceListingBuilder

Updates the api information

isAllowEmptyValue() - Method in class springfox.documentation.schema.ModelProperty

Support for isAllowEmpty value

isAllowEmptyValue() - Method in class springfox.documentation.service.Parameter

isAllowMultiple() - Method in class springfox.documentation.service.Parameter

isAnnotatedWith(Class<? extends Annotation>) - Method in interface springfox.documentation.RequestHandler

isCollection() - Method in class springfox.documentation.schema.ModelRef

isCollection() - Method in interface springfox.documentation.schema.ModelReference

isHidden(Boolean) - Method in class springfox.documentation.builders.ModelPropertyBuilder

isHidden() - Method in class springfox.documentation.schema.ModelProperty

isHidden() - Method in class springfox.documentation.service.ApiDescription

isHidden() - Method in class springfox.documentation.service.Operation

isHidden() - Method in class springfox.documentation.service.Parameter

isMap() - Method in class springfox.documentation.schema.ModelRef

isMap() - Method in interface springfox.documentation.schema.ModelReference

isReadOnly() - Method in class springfox.documentation.schema.ModelProperty

isRequired() - Method in class springfox.documentation.schema.ModelProperty

isRequired() - Method in class springfox.documentation.service.Parameter

itemModel() - Method in class springfox.documentation.schema.ModelRef

itemModel() - Method in interface springfox.documentation.schema.ModelReference

K

key() - Method in interface springfox.documentation.RequestHandler

L

license(String) - Method in class springfox.documentation.builders.ApiInfoBuilder

Updates license information for this API

licenseUrl(String) - Method in class springfox.documentation.builders.ApiInfoBuilder

Updates the license Url for this API

ListVendorExtension<T> - Class in springfox.documentation.service

ListVendorExtension(String, List<T>) - Constructor for class springfox.documentation.service.ListVendorExtension

loginEndpoint(LoginEndpoint) - Method in class springfox.documentation.builders.ImplicitGrantBuilder

Updates the login endpoint

LoginEndpoint - Class in springfox.documentation.service

LoginEndpoint(String) - Constructor for class springfox.documentation.service.LoginEndpoint

LoginEndpointBuilder - Class in springfox.documentation.builders

LoginEndpointBuilder() - Constructor for class springfox.documentation.builders.LoginEndpointBuilder

M

MediaTypes - Class in springfox.documentation.service

message(String) - Method in class springfox.documentation.builders.ResponseMessageBuilder

Updates the response message

method(HttpMethod) - Method in class springfox.documentation.builders.OperationBuilder

Updates the http method

Model - Class in springfox.documentation.schema

Model(String, String, ResolvedType, String, Map<String, ModelProperty>, String, String, String, List<ModelReference>, Object, Xml) - Constructor for class springfox.documentation.schema.Model

ModelBuilder - Class in springfox.documentation.builders

ModelBuilder() - Constructor for class springfox.documentation.builders.ModelBuilder

ModelProperty - Class in springfox.documentation.schema

ModelProperty(String, ResolvedType, String, int, boolean, boolean, boolean, Boolean, String, AllowableValues, Object, String, String, Xml, List<VendorExtension>) - Constructor for class springfox.documentation.schema.ModelProperty

ModelPropertyBuilder - Class in springfox.documentation.builders

ModelPropertyBuilder() - Constructor for class springfox.documentation.builders.ModelPropertyBuilder

modelRef(ModelReference) - Method in class springfox.documentation.builders.ParameterBuilder

Represents the convenience method to infer the model reference Consolidate or figure out whats can be rolled into the other.

ModelRef - Class in springfox.documentation.schema

ModelRef(String) - Constructor for class springfox.documentation.schema.ModelRef

ModelRef(String, ModelReference) - Constructor for class springfox.documentation.schema.ModelRef

ModelRef(String, ModelReference, AllowableValues) - Constructor for class springfox.documentation.schema.ModelRef

ModelRef(String, AllowableValues) - Constructor for class springfox.documentation.schema.ModelRef

ModelRef(String, ModelReference, boolean) - Constructor for class springfox.documentation.schema.ModelRef

ModelRef(String, ModelReference, AllowableValues, boolean) - Constructor for class springfox.documentation.schema.ModelRef

ModelReference - Interface in springfox.documentation.schema

models(Map<String, Model>) - Method in class springfox.documentation.builders.ApiListingBuilder

Adds to the models collection

N

name(String) - Method in class springfox.documentation.builders.DocumentationBuilder

Name of the documentation group

name(String) - Method in class springfox.documentation.builders.ModelBuilder

Updates the Name of the model

name(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder

name(String) - Method in class springfox.documentation.builders.OAuthBuilder

Updates the unique name to identify the security definition

name(String) - Method in class springfox.documentation.builders.ParameterBuilder

Updates the parameter name

name(String) - Method in class springfox.documentation.schema.Xml

name - Variable in class springfox.documentation.service.SecurityScheme

namespace(String) - Method in class springfox.documentation.schema.Xml

newMapRule(Class<?>, Class<?>) - Static method in class springfox.documentation.schema.AlternateTypeRules

Helper method to create a new alternate for Map<K,V> that results in an alternate of type List<Entry<K,V>>.

newRule(Type, Type) - Static method in class springfox.documentation.schema.AlternateTypeRules

Helper method to create a new alternate rule.

newRule(Type, Type, int) - Static method in class springfox.documentation.schema.AlternateTypeRules

Helper method to create a new alternate rule.

none() - Static method in class springfox.documentation.builders.PathSelectors

No path satisfies this condition

none() - Static method in class springfox.documentation.builders.RequestHandlerSelectors

No RequestHandler satisfies this condition

notes(String) - Method in class springfox.documentation.builders.OperationBuilder

Updates the operation notes

nullToEmptyList(Collection<T>) - Static method in class springfox.documentation.builders.BuilderDefaults

Returns an empty list if the newValue is null

nullToEmptyMap(Map<K, V>) - Static method in class springfox.documentation.builders.BuilderDefaults

Returns an empty map if the input is null

nullToEmptyMultimap(Multimap<K, V>) - Static method in class springfox.documentation.builders.BuilderDefaults

Returns an empty map if the input is null

nullToEmptySet(Set<T>) - Static method in class springfox.documentation.builders.BuilderDefaults

Returns an empty set if the newValue is null

nullVarArgsToEmptyList(T...) - Static method in class springfox.documentation.builders.BuilderDefaults

Returns an empty list if the newValue is null

O

OAuth - Class in springfox.documentation.service

OAuth(String, List<AuthorizationScope>, List<GrantType>, List<VendorExtension>) - Constructor for class springfox.documentation.service.OAuth

OAuth(String, List<AuthorizationScope>, List<GrantType>) - Constructor for class springfox.documentation.service.OAuth

OAuthBuilder - Class in springfox.documentation.builders

OAuthBuilder() - Constructor for class springfox.documentation.builders.OAuthBuilder

ObjectVendorExtension - Class in springfox.documentation.service

ObjectVendorExtension(String) - Constructor for class springfox.documentation.service.ObjectVendorExtension

Operation - Class in springfox.documentation.service

Operation(HttpMethod, String, String, ModelReference, String, int, Set<String>, Set<String>, Set<String>, Set<String>, List<SecurityReference>, List<Parameter>, Set<ResponseMessage>, String, boolean, Collection<VendorExtension>) - Constructor for class springfox.documentation.service.Operation

OperationBuilder - Class in springfox.documentation.builders

OperationBuilder(OperationNameGenerator) - Constructor for class springfox.documentation.builders.OperationBuilder

OperationNameGenerator - Interface in springfox.documentation

operations(List<Operation>) - Method in class springfox.documentation.builders.ApiDescriptionBuilder

Updates the operations to the api operation

order(int) - Method in class springfox.documentation.builders.ParameterBuilder

Updates default order of precedence of parameters

order - Variable in class springfox.documentation.schema.AlternateTypeRule

original - Variable in class springfox.documentation.schema.AlternateTypeRule

P

Parameter - Class in springfox.documentation.service

Parameter(String, String, String, boolean, boolean, Boolean, ModelReference, Optional<ResolvedType>, AllowableValues, String, String, boolean, String, String, int, Object, Multimap<String, Example>, List<VendorExtension>) - Constructor for class springfox.documentation.service.Parameter

parameterAccess(String) - Method in class springfox.documentation.builders.ParameterBuilder

Updates the parameter access

ParameterBuilder - Class in springfox.documentation.builders

ParameterBuilder() - Constructor for class springfox.documentation.builders.ParameterBuilder

parameters(List<Parameter>) - Method in class springfox.documentation.builders.OperationBuilder

Updates the input parameters this operation needs

Parameters - Class in springfox.documentation.builders

parameterType(String) - Method in class springfox.documentation.builders.ParameterBuilder

Updates the type of parameter

params() - Method in interface springfox.documentation.RequestHandler

path(String) - Method in class springfox.documentation.builders.ApiDescriptionBuilder

Updates the path to the api operation

pathDecorator(Function<String, String>) - Method in class springfox.documentation.builders.ApiDescriptionBuilder

PathProvider - Interface in springfox.documentation

PathSelectors - Class in springfox.documentation.builders

pattern(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder

pattern(String) - Method in class springfox.documentation.builders.ParameterBuilder

position(int) - Method in class springfox.documentation.builders.ApiListingBuilder

Updates the position of the listing

position(int) - Method in class springfox.documentation.builders.ModelPropertyBuilder

position(int) - Method in class springfox.documentation.builders.OperationBuilder

Updates the index of the operation

prefix(String) - Method in class springfox.documentation.schema.Xml

produces(Set<String>) - Method in class springfox.documentation.builders.ApiListingBuilder

Replaces the existing media types with new entries that this documentation produces

produces(Set<String>) - Method in class springfox.documentation.builders.DocumentationBuilder

Updates the existing media types with new entries that this documentation produces

produces(Set<String>) - Method in class springfox.documentation.builders.OperationBuilder

Updates the existing media types with new entries that this documentation produces

produces() - Method in interface springfox.documentation.RequestHandler

properties(Map<String, ModelProperty>) - Method in class springfox.documentation.builders.ModelBuilder

Updates the model properties

property(AlternateTypePropertyBuilder) - Method in class springfox.documentation.builders.AlternateTypeBuilder

protocols(Set<String>) - Method in class springfox.documentation.builders.ApiListingBuilder

Appends to the exiting collection of supported protocols

protocols(Set<String>) - Method in class springfox.documentation.builders.OperationBuilder

Update the protocols this operation supports

Q

qualifiedType(String) - Method in class springfox.documentation.builders.ModelBuilder

Fully package qualified name of the model

qualifiedType(String) - Method in class springfox.documentation.builders.ModelPropertyBuilder

R

readOnly(Boolean) - Method in class springfox.documentation.builders.ModelPropertyBuilder

reference(String) - Method in class springfox.documentation.service.SecurityReference.SecurityReferenceBuilder

Updates the authorization reference for the api.

regex(String) - Static method in class springfox.documentation.builders.PathSelectors

Predicate that evaluates the supplied regular expression

replaceIfMoreSpecific(ResolvedType, ResolvedType) - Static method in class springfox.documentation.builders.BuilderDefaults

Coalesces the resolved type.

replaceProperty(VendorExtension) - Method in class springfox.documentation.service.ObjectVendorExtension

replaceResolvedParameterType(ResolvedType) - Method in class springfox.documentation.service.ResolvedMethodParameter

RequestHandler - Interface in springfox.documentation

RequestHandlerKey - Class in springfox.documentation

RequestHandlerKey(Set<String>, Set<RequestMethod>, Set<? extends MediaType>, Set<? extends MediaType>) - Constructor for class springfox.documentation.RequestHandlerKey

RequestHandlerSelectors - Class in springfox.documentation.builders

required(Boolean) - Method in class springfox.documentation.builders.ModelPropertyBuilder

required(boolean) - Method in class springfox.documentation.builders.ParameterBuilder

Updates if the parameter is required or optional

ResolvedMethodParameter - Class in springfox.documentation.service

ResolvedMethodParameter(String, MethodParameter, ResolvedType) - Constructor for class springfox.documentation.service.ResolvedMethodParameter

ResolvedMethodParameter(int, String, List<Annotation>, ResolvedType) - Constructor for class springfox.documentation.service.ResolvedMethodParameter

ResourceGroup - Class in springfox.documentation.service

ResourceGroup(String, Class<?>) - Constructor for class springfox.documentation.service.ResourceGroup

ResourceGroup(String, Class<?>, Integer) - Constructor for class springfox.documentation.service.ResourceGroup

resourceListing(ResourceListing) - Method in class springfox.documentation.builders.DocumentationBuilder

Updates the resource listing

ResourceListing - Class in springfox.documentation.service

ResourceListing(String, List<ApiListingReference>, List<SecurityScheme>, ApiInfo) - Constructor for class springfox.documentation.service.ResourceListing

ResourceListingBuilder - Class in springfox.documentation.builders

ResourceListingBuilder() - Constructor for class springfox.documentation.builders.ResourceListingBuilder

ResourceOwnerPasswordCredentialsGrant - Class in springfox.documentation.service

ResourceOwnerPasswordCredentialsGrant(String) - Constructor for class springfox.documentation.service.ResourceOwnerPasswordCredentialsGrant

resourcePath(String) - Method in class springfox.documentation.builders.ApiListingBuilder

Updates resource path for the api listing

ResponseMessage - Class in springfox.documentation.service

ResponseMessage(int, String, ModelReference, Map<String, Header>, List<VendorExtension>) - Constructor for class springfox.documentation.service.ResponseMessage

ResponseMessageBuilder - Class in springfox.documentation.builders

ResponseMessageBuilder() - Constructor for class springfox.documentation.builders.ResponseMessageBuilder

responseMessages(Set<ResponseMessage>) - Method in class springfox.documentation.builders.OperationBuilder

Updates the response messages

responseModel(ModelReference) - Method in class springfox.documentation.builders.OperationBuilder

Updates the reference to the response model

responseModel(ModelReference) - Method in class springfox.documentation.builders.ResponseMessageBuilder

Updates the model the response represents

rules() - Method in interface springfox.documentation.schema.AlternateTypeRuleConvention

S

scalarExample(Object) - Method in class springfox.documentation.builders.ParameterBuilder

schemes(Set<String>) - Method in class springfox.documentation.builders.DocumentationBuilder

Updates the schemes this api supports

scope(String) - Method in class springfox.documentation.builders.AuthorizationScopeBuilder

Updates the scope

scopes(List<AuthorizationScope>) - Method in class springfox.documentation.builders.OAuthBuilder

Updates the authorization scopes with the new scopes

scopes(AuthorizationScope[]) - Method in class springfox.documentation.service.SecurityReference.SecurityReferenceBuilder

Updates the authorization scopes that this authorization applies to.

SecurityReference - Class in springfox.documentation.service

SecurityReference(String, AuthorizationScope[]) - Constructor for class springfox.documentation.service.SecurityReference

SecurityReference.SecurityReferenceBuilder - Class in springfox.documentation.service

securityReferences(List<SecurityReference>) - Method in class springfox.documentation.builders.ApiListingBuilder

Updates the references to the security definitions

SecurityScheme - Class in springfox.documentation.service

SecurityScheme(String, String) - Constructor for class springfox.documentation.service.SecurityScheme

securitySchemes(List<? extends SecurityScheme>) - Method in class springfox.documentation.builders.ResourceListingBuilder

Updates the security definitions that protect this resource listing

setAttribute(Boolean) - Method in class springfox.documentation.schema.Xml

setKey(V) - Method in class springfox.documentation.schema.Entry

setName(String) - Method in class springfox.documentation.schema.Xml

setNamespace(String) - Method in class springfox.documentation.schema.Xml

setPrefix(String) - Method in class springfox.documentation.schema.Xml

setWrapped(Boolean) - Method in class springfox.documentation.schema.Xml

springfox.documentation - package springfox.documentation

springfox.documentation.annotations - package springfox.documentation.annotations

springfox.documentation.builders - package springfox.documentation.builders

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

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

startingWith(String) - Method in interface springfox.documentation.OperationNameGenerator

StringVendorExtension - Class in springfox.documentation.service

StringVendorExtension(String, String) - Constructor for class springfox.documentation.service.StringVendorExtension

subTypes(List<ModelReference>) - Method in class springfox.documentation.builders.ModelBuilder

Updates the subclasses for this model.

summary(String) - Method in class springfox.documentation.builders.OperationBuilder

Updates the operation summary

supportedMethods() - Method in interface springfox.documentation.RequestHandler

T

Tag - Class in springfox.documentation.service

Tag(String, String) - Constructor for class springfox.documentation.service.Tag

Tag(String, String, int) - Constructor for class springfox.documentation.service.Tag

Tag(String, String, List<VendorExtension>) - Constructor for class springfox.documentation.service.Tag

Tag(String, String, int, List<VendorExtension>) - Constructor for class springfox.documentation.service.Tag

tagComparator() - Static method in class springfox.documentation.service.Tags

tagNames(Set<String>) - Method in class springfox.documentation.builders.ApiListingBuilder

Updates the tags

tags(Set<Tag>) - Method in class springfox.documentation.builders.ApiListingBuilder

Updates the tags.

tags(Set<Tag>) - Method in class springfox.documentation.builders.DocumentationBuilder

Updates the tags with new entries

tags(Set<String>) - Method in class springfox.documentation.builders.OperationBuilder

Updates the tags that identify this operation

Tags - Class in springfox.documentation.service

termsOfServiceUrl(String) - Method in class springfox.documentation.builders.ApiInfoBuilder

Updates the terms of service url

title(String) - Method in class springfox.documentation.builders.ApiInfoBuilder

Updates the api title

tokenEndpoint(TokenEndpoint) - Method in class springfox.documentation.builders.AuthorizationCodeGrantBuilder

Updates token endpoint

TokenEndpoint - Class in springfox.documentation.service

TokenEndpoint(String, String) - Constructor for class springfox.documentation.service.TokenEndpoint

TokenEndpointBuilder - Class in springfox.documentation.builders

TokenEndpointBuilder() - Constructor for class springfox.documentation.builders.TokenEndpointBuilder

tokenName(String) - Method in class springfox.documentation.builders.ImplicitGrantBuilder

Updates the token name

tokenName(String) - Method in class springfox.documentation.builders.TokenEndpointBuilder

Updates the token name

tokenRequestEndpoint(TokenRequestEndpoint) - Method in class springfox.documentation.builders.AuthorizationCodeGrantBuilder

Updates token request endpoint

TokenRequestEndpoint - Class in springfox.documentation.service

TokenRequestEndpoint(String, String, String) - Constructor for class springfox.documentation.service.TokenRequestEndpoint

TokenRequestEndpointBuilder - Class in springfox.documentation.builders

TokenRequestEndpointBuilder() - Constructor for class springfox.documentation.builders.TokenRequestEndpointBuilder

toMediaTypes(Set<String>) - Static method in class springfox.documentation.service.MediaTypes

toParameterName() - Static method in class springfox.documentation.builders.Parameters

toString() - Method in class springfox.documentation.RequestHandlerKey

toString() - Method in class springfox.documentation.schema.Example

toString() - Method in class springfox.documentation.service.Header

toString() - Method in class springfox.documentation.service.ObjectVendorExtension

toString() - Method in class springfox.documentation.service.Parameter

toString() - Method in class springfox.documentation.service.ResourceGroup

toString() - Method in class springfox.documentation.service.StringVendorExtension

toTag(Function<String, String>) - Static method in class springfox.documentation.service.Tags

toTagName() - Static method in class springfox.documentation.service.Tags

toTags(Multimap<String, ApiListing>) - Static method in class springfox.documentation.service.Tags

type(ResolvedType) - Method in class springfox.documentation.builders.ModelBuilder

Represents the type information with full fidelity of generics

type(ResolvedType) - Method in class springfox.documentation.builders.ModelPropertyBuilder

type(ResolvedType) - Method in class springfox.documentation.builders.ParameterBuilder

Updates the type of parameter

type - Variable in class springfox.documentation.service.SecurityScheme

U

uniqueId(String) - Method in class springfox.documentation.builders.OperationBuilder

Updates the uniqueId for the operation.

updateModelRef(Function<ResolvedType, ? extends ModelReference>) - Method in class springfox.documentation.schema.ModelProperty

url(String) - Method in class springfox.documentation.builders.LoginEndpointBuilder

Updates the url for the login endpoint

url(String) - Method in class springfox.documentation.builders.TokenEndpointBuilder

Updates the token endpoint url

url(String) - Method in class springfox.documentation.builders.TokenRequestEndpointBuilder

Updates the url for the token request endpoint

V

VendorExtension<T> - Interface in springfox.documentation.service

vendorExtensions(List<VendorExtension>) - Method in class springfox.documentation.builders.ParameterBuilder

Updates the parameter extensions

vendorExtensions(List<VendorExtension>) - Method in class springfox.documentation.builders.ResponseMessageBuilder

Updates the response message extensions

version(String) - Method in class springfox.documentation.builders.ApiInfoBuilder

Updates the api version

W

wildcardMatch(ResolvedType, ResolvedType) - Static method in class springfox.documentation.schema.WildcardType

WildcardType - Class in springfox.documentation.schema

withAnnotations(List<Annotation>) - Method in class springfox.documentation.builders.AlternateTypeBuilder

withAnnotations(List<Annotation>) - Method in class springfox.documentation.builders.AlternateTypePropertyBuilder

withCanRead(boolean) - Method in class springfox.documentation.builders.AlternateTypePropertyBuilder

withCanWrite(boolean) - Method in class springfox.documentation.builders.AlternateTypePropertyBuilder

withClassAnnotation(Class<? extends Annotation>) - Static method in class springfox.documentation.builders.RequestHandlerSelectors

Predicate that matches RequestHandler with given annotation on the declaring class of the handler method

withMethodAnnotation(Class<? extends Annotation>) - Static method in class springfox.documentation.builders.RequestHandlerSelectors

Predicate that matches RequestHandler with handlers methods annotated with given annotation

withName(String) - Method in class springfox.documentation.builders.AlternateTypePropertyBuilder

withName(String) - Static method in class springfox.documentation.builders.Parameters

withProperties(List<AlternateTypePropertyBuilder>) - Method in class springfox.documentation.builders.AlternateTypeBuilder

withType(Class<?>) - Method in class springfox.documentation.builders.AlternateTypePropertyBuilder

wrapped(Boolean) - Method in class springfox.documentation.schema.Xml

X

xml(Xml) - Method in class springfox.documentation.builders.ModelBuilder

xml(Xml) - Method in class springfox.documentation.builders.ModelPropertyBuilder

Xml - Class in springfox.documentation.schema

Xml() - Constructor for class springfox.documentation.schema.Xml

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