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

A

accepts(Collection<MediaType>) - Method in class springfox.documentation.builders.RequestParameterBuilder

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

addServer(Server) - Method in class springfox.documentation.service.Documentation

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

ALL_OF - springfox.documentation.service.Qualifier

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, Boolean, String, Boolean) - Constructor for class springfox.documentation.service.AllowableRangeValues

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

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

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

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

Deprecated.

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

AllowableValues - Interface in springfox.documentation.service

allowedValues(Collection<String>) - Method in class springfox.documentation.builders.EnumerationElementFacetBuilder

allowedValues(List<String>) - Method in class springfox.documentation.builders.ServerVariableBuilder

allowedValues(AllowableValues) - Method in class springfox.documentation.builders.EnumerationElementFacetBuilder

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

Support for isAllowEmpty value

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

Deprecated.

Updates the flag that allows sending empty values for this parameter

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

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

Allows empty values

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

Deprecated.

Updates if the parameter should allow multiple values

allowReserved(Boolean) - Method in class springfox.documentation.builders.EncodingBuilder

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

Deprecated.

allowReserved(Boolean) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder

Allows reserved characters

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

Deprecated.

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

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

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

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

ANY_OF - springfox.documentation.service.Qualifier

ApiDescription - Class in springfox.documentation.service

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

ApiDescriptionBuilder - Class in springfox.documentation.builders

ApiDescriptionBuilder(Comparator<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.

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>, Map<String, ModelSpecification>, ModelNamesRegistry, String, int, Set<Tag>) - Constructor for class springfox.documentation.service.ApiListing

ApiListingBuilder - Class in springfox.documentation.builders

ApiListingBuilder(Comparator<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(Map<String, List<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

ARRAY - springfox.documentation.schema.CollectionType

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

authorizationUrl(String) - Method in class springfox.documentation.builders.OAuth2SchemeBuilder

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

Globally configured tags

B

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

Deprecated.

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

BASIC_AUTH_BUILDER - Static variable in class springfox.documentation.service.HttpAuthenticationScheme

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

bearerFormat(String) - Method in class springfox.documentation.builders.HttpAuthenticationBuilder

BIGDECIMAL - Static variable in class springfox.documentation.schema.ScalarType

BIGINTEGER - Static variable in class springfox.documentation.schema.ScalarType

BINARY - Static variable in class springfox.documentation.schema.ScalarType

BODY - springfox.documentation.service.ParameterType

BodyParameterSpecificationProvider - Class in springfox.documentation.builders

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

BOOLEAN - Static variable in class springfox.documentation.schema.ScalarType

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.CollectionElementFacetBuilder

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

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

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

build() - Method in interface springfox.documentation.builders.ElementFacetBuilder

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

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

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

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

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

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

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

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

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

Deprecated.

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

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

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

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

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

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

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

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

Deprecated.

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

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

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

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

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

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

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

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

Deprecated.

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

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

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

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

build() - Method in class springfox.documentation.schema.ModelKeyBuilder

build() - Method in class springfox.documentation.schema.NumericElementFacetBuilder

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

builderFactory(Class<T>) - Static method in class springfox.documentation.builders.ElementFacets

builtInScalarType(Type) - Static method in class springfox.documentation.schema.ScalarTypes

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

byOperationName() - Static method in interface springfox.documentation.RequestHandler

byPatternsCondition() - Static method in interface springfox.documentation.RequestHandler

BYTE - Static variable in class springfox.documentation.schema.ScalarType

C

Cacheable - Annotation Type in springfox.documentation.annotations

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

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

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

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

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

ClassNotPresentInClassPathCondition - Class in springfox.documentation.common

ClassNotPresentInClassPathCondition() - Constructor for class springfox.documentation.common.ClassNotPresentInClassPathCondition

ClassPresentInClassPathCondition - Class in springfox.documentation.common

ClassPresentInClassPathCondition() - Constructor for class springfox.documentation.common.ClassPresentInClassPathCondition

ClassSupport - Class in springfox.documentation.schema

clearEncodings() - Method in class springfox.documentation.builders.RepresentationBuilder

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

Deprecated.

Updates the http response code

code(String) - Method in class springfox.documentation.builders.ResponseBuilder

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.

CollectionElementFacet - Class in springfox.documentation.schema

CollectionElementFacet(Integer, Integer, Boolean) - Constructor for class springfox.documentation.schema.CollectionElementFacet

CollectionElementFacetBuilder - Class in springfox.documentation.builders

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

collectionFacet(Consumer<CollectionElementFacetBuilder>) - Method in class springfox.documentation.builders.ModelFacetsBuilder

collectionFacet(Consumer<CollectionElementFacetBuilder>) - Method in class springfox.documentation.builders.PropertySpecificationBuilder

collectionFacet(Consumer<CollectionElementFacetBuilder>) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder

Provides consumer to help uild collection element facet

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

Deprecated.

Updates the parameter extensions

collectionFormat(CollectionFormat) - Method in class springfox.documentation.builders.CollectionElementFacetBuilder

collectionFormat(CollectionFormat) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder

Deprecated.

CollectionFormat - Class in springfox.documentation.service

collectionModel(Consumer<CollectionSpecificationBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder

Provides a consumer to build the collection model

collectionModelIfExists(Consumer<CollectionSpecificationBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder

Conditionally provides a consumer to build the colleciton model.

CollectionSpecification - Class in springfox.documentation.schema

CollectionSpecification(ModelSpecification, CollectionType) - Constructor for class springfox.documentation.schema.CollectionSpecification

CollectionSpecificationBuilder - Class in springfox.documentation.builders

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

collectionType(CollectionType) - Method in class springfox.documentation.builders.CollectionSpecificationBuilder

CollectionType - Enum in springfox.documentation.schema

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

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

combine(PatternsRequestCondition<T>) - Method in interface springfox.documentation.spring.wrapper.PatternsRequestCondition

compareTo(Version) - Method in class springfox.documentation.common.Version

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

Compatibility<T,U> - Class in springfox.documentation.common

Compatibility(T, U) - Constructor for class springfox.documentation.common.Compatibility

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

Deprecated.

compoundModel(Consumer<CompoundModelSpecificationBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder

Provides a consumer to help building a compound model

compoundModelIfExists(Consumer<CompoundModelSpecificationBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder

Provides a consumer to help build a compound model if one already exists.

CompoundModelSpecification - Class in springfox.documentation.schema

CompoundModelSpecification(ModelKey, Collection<PropertySpecification>, Integer, Integer, String, List<ReferenceModelSpecification>) - Constructor for class springfox.documentation.schema.CompoundModelSpecification

CompoundModelSpecificationBuilder - Class in springfox.documentation.builders

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

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

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

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

content(Consumer<ContentSpecificationBuilder>) - Method in class springfox.documentation.builders.RequestParameterBuilder

contentModel(ModelSpecification) - Method in class springfox.documentation.builders.RequestParameterBuilder

ContentSpecification - Class in springfox.documentation.service

ContentSpecification(boolean, Set<Representation>) - Constructor for class springfox.documentation.service.ContentSpecification

ContentSpecificationBuilder - Class in springfox.documentation.builders

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

contentType(String) - Method in class springfox.documentation.builders.EncodingBuilder

convert(String) - Static method in class springfox.documentation.service.CollectionFormat

COOKIE - springfox.documentation.service.ParameterType

CookieParameterSpecificationProvider - Class in springfox.documentation.builders

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

copyOf(CollectionSpecification) - Method in class springfox.documentation.builders.CollectionSpecificationBuilder

copyOf(CompoundModelSpecification) - Method in class springfox.documentation.builders.CompoundModelSpecificationBuilder

Copies from an existing model

copyOf(ElementFacet) - Method in class springfox.documentation.builders.CollectionElementFacetBuilder

copyOf(ElementFacet) - Method in interface springfox.documentation.builders.ElementFacetBuilder

copyOf(ElementFacet) - Method in class springfox.documentation.builders.EnumerationElementFacetBuilder

copyOf(ElementFacet) - Method in class springfox.documentation.builders.StringElementFacetBuilder

copyOf(ElementFacet) - Method in class springfox.documentation.schema.NumericElementFacetBuilder

copyOf(MapSpecification) - Method in class springfox.documentation.builders.MapSpecificationBuilder

copyOf(ModelFacets) - Method in class springfox.documentation.builders.ModelFacetsBuilder

copyOf(ModelKey) - Method in class springfox.documentation.schema.ModelKeyBuilder

copyOf(ModelSpecification) - Method in class springfox.documentation.builders.ModelSpecificationBuilder

Copies from an other model

copyOf(QualifiedModelName) - Method in class springfox.documentation.builders.QualifiedModelNameBuilder

copyOf(ReferenceModelSpecification) - Method in class springfox.documentation.builders.ReferenceModelSpecificationBuilder

copyOf(ContentSpecification) - Method in class springfox.documentation.builders.ContentSpecificationBuilder

copyOf(Encoding) - Method in class springfox.documentation.builders.EncodingBuilder

copyOf(Representation) - Method in class springfox.documentation.builders.RepresentationBuilder

copyOf(RequestParameter) - Method in class springfox.documentation.builders.RequestParameterBuilder

copyOf(Response) - Method in class springfox.documentation.builders.ResponseBuilder

copyOf(SimpleParameterSpecification) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder

Method they copy from a specification

create(ParameterSpecificationContext) - Method in class springfox.documentation.builders.BodyParameterSpecificationProvider

create(ParameterSpecificationContext) - Method in class springfox.documentation.builders.CookieParameterSpecificationProvider

create(ParameterSpecificationContext) - Method in class springfox.documentation.builders.FormParameterSpecificationProvider

create(ParameterSpecificationContext) - Method in class springfox.documentation.builders.HeaderParameterSpecificationProvider

create(ParameterSpecificationContext) - Method in class springfox.documentation.builders.MultipartFormDataParameterSpecificationProvider

create(ParameterSpecificationContext) - Method in interface springfox.documentation.builders.ParameterSpecificationProvider

create(ParameterSpecificationContext) - Method in class springfox.documentation.builders.PathParameterSpecificationProvider

create(ParameterSpecificationContext) - Method in class springfox.documentation.builders.RootParameterSpecificationProvider

createServerVariable() - Method in class springfox.documentation.builders.ServerVariableBuilder

CredentialsGrant - Class in springfox.documentation.service

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

CSV - Static variable in class springfox.documentation.service.CollectionFormat

CURRENCY - Static variable in class springfox.documentation.schema.ScalarType

D

DATE - Static variable in class springfox.documentation.schema.ScalarType

DATE_TIME - Static variable in class springfox.documentation.schema.ScalarType

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

Deprecated.

DEEPOBJECT - springfox.documentation.service.ParameterStyle

DEFAULT - springfox.documentation.service.ParameterStyle

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

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

DEFAULT_MULTIPLE - Static variable in class springfox.documentation.schema.NumericElementFacet

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

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(Object) - Method in class springfox.documentation.builders.PropertySpecificationBuilder

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

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

Deprecated.

Updates the default value of the parameter

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

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

Default value

deprecated(Boolean) - Method in class springfox.documentation.builders.ModelFacetsBuilder

deprecated(Boolean) - Method in class springfox.documentation.builders.PropertySpecificationBuilder

deprecated(Boolean) - Method in class springfox.documentation.builders.RequestParameterBuilder

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.ExampleBuilder

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

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

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

Deprecated.

Update the description of the model

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

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

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

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

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

Deprecated.

Updates the description of the parameter

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

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

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

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

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

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.CompoundModelSpecificationBuilder

Inheritance discriminator

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

Deprecated.

Updates inheritance discriminator, used to identify inherited subclasses.

Documentation - Class in springfox.documentation.service

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

DocumentationBuilder - Class in springfox.documentation.builders

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

DocumentationReference - Class in springfox.documentation.service

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

DOUBLE - Static variable in class springfox.documentation.schema.ScalarType

E

Either<L,R> - Class in springfox.documentation.common

Either(L) - Constructor for class springfox.documentation.common.Either

Either(L, R) - Constructor for class springfox.documentation.common.Either

elementFacet(Class<T>) - Method in interface springfox.documentation.schema.ElementFacetSource

elementFacet(Class<T>) - Method in class springfox.documentation.schema.ModelFacets

elementFacet(Class<T>) - Method in class springfox.documentation.schema.PropertySpecification

ElementFacet - Interface in springfox.documentation.schema

ElementFacetBuilder - Interface in springfox.documentation.builders

ElementFacets - Class in springfox.documentation.builders

ElementFacetSource - Interface in springfox.documentation.schema

EMAIL - Static variable in class springfox.documentation.schema.ScalarType

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

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

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

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

Retains current allowable values if then new value is null

encoding(String) - Method in class springfox.documentation.builders.RepresentationBuilder

Encoding - Class in springfox.documentation.service

Encoding(String, String, ParameterStyle, Boolean, Boolean, Set<Header>, Collection<VendorExtension>) - Constructor for class springfox.documentation.service.Encoding

EncodingBuilder - Class in springfox.documentation.builders

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

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

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

EnumerationElementFacetBuilder - Class in springfox.documentation.builders

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

enumerationFacet(Consumer<EnumerationElementFacetBuilder>) - Method in class springfox.documentation.builders.ModelFacetsBuilder

enumerationFacet(Consumer<EnumerationElementFacetBuilder>) - Method in class springfox.documentation.builders.PropertySpecificationBuilder

enumerationFacet(Consumer<EnumerationElementFacetBuilder>) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder

Provides consumer to help build enumeration element facet

EnumerationFacet - Class in springfox.documentation.schema

EnumerationFacet(Collection<String>) - Constructor for class springfox.documentation.schema.EnumerationFacet

Enums - Class in springfox.documentation.schema

equals(Object) - Method in class springfox.documentation.common.Compatibility

equals(Object) - Method in class springfox.documentation.common.Either

equals(Object) - Method in class springfox.documentation.common.ExternalDocumentation

equals(Object) - Method in class springfox.documentation.common.Version

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

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

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

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

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

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

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

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

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

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

Deprecated.

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

Deprecated.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Deprecated.

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

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

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

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

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

equalsIgnoringName(Object) - Method in class springfox.documentation.schema.Model

Deprecated.

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

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

Deprecated.

Updates the Example for the model

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

Updates the example

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

example(Example) - Method in class springfox.documentation.builders.RequestParameterBuilder

Example - Class in springfox.documentation.schema

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

Deprecated.

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

Deprecated.

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

ExampleBuilder - Class in springfox.documentation.builders

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

examples(Collection<Example>) - Method in class springfox.documentation.builders.RequestParameterBuilder

examples(Collection<Example>) - Method in class springfox.documentation.builders.ResponseBuilder

examples(List<Example>) - Method in class springfox.documentation.builders.ModelFacetsBuilder

examples(List<Example>) - Method in class springfox.documentation.builders.ResponseMessageBuilder

Deprecated.

Updates the response examples

exclusiveMaximum(Boolean) - Method in class springfox.documentation.schema.NumericElementFacetBuilder

exclusiveMinimum(Boolean) - Method in class springfox.documentation.schema.NumericElementFacetBuilder

explode(Boolean) - Method in class springfox.documentation.builders.EncodingBuilder

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

Deprecated.

explode(Boolean) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder

Use this if we want to explode collections

extensions(Collection<VendorExtension>) - Method in class springfox.documentation.builders.ExternalDocumentationBuilder

extensions(Collection<VendorExtension>) - Method in class springfox.documentation.builders.ServerBuilder

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.HttpAuthenticationBuilder

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

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

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

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

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

Updates the operation extensions

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

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

externalDocumentation(Consumer<ExternalDocumentationBuilder>) - Method in class springfox.documentation.builders.DocumentationBuilder

Adds external documentation information for this API

externalDocumentation(ExternalDocumentation) - Method in class springfox.documentation.builders.ModelFacetsBuilder

externalDocumentation(ExternalDocumentation) - Method in class springfox.documentation.builders.OperationBuilder

ExternalDocumentation - Class in springfox.documentation.common

ExternalDocumentation(String, String, Collection<VendorExtension>) - Constructor for class springfox.documentation.common.ExternalDocumentation

ExternalDocumentationBuilder - Class in springfox.documentation.builders

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

externalValue(String) - Method in class springfox.documentation.builders.ExampleBuilder

F

facetBuilder() - Method in class springfox.documentation.schema.CollectionElementFacet

facetBuilder() - Method in interface springfox.documentation.schema.ElementFacet

facetBuilder() - Method in class springfox.documentation.schema.EnumerationFacet

facetBuilder() - Method in class springfox.documentation.schema.NumericElementFacet

facetBuilder() - Method in class springfox.documentation.schema.StringElementFacet

facetBuilder(Class<T>) - Method in class springfox.documentation.builders.PropertySpecificationBuilder

facetOfType(Class<T>) - Method in class springfox.documentation.service.SimpleParameterSpecification

facets(Consumer<ModelFacetsBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder

Provides a consumer to build facets

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

flippedResponse() - Method in class springfox.documentation.schema.ModelKey

FLOAT - Static variable in class springfox.documentation.schema.ScalarType

FORM - springfox.documentation.service.ParameterStyle

FORM - springfox.documentation.service.ParameterType

FORMDATA - springfox.documentation.service.ParameterType

FormParameterSpecificationProvider - Class in springfox.documentation.builders

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

from(String) - Static method in enum springfox.documentation.service.ParameterType

from(String, String) - Static method in class springfox.documentation.schema.ScalarType

from(AllowableRangeValues) - Method in class springfox.documentation.schema.NumericElementFacetBuilder

from(AllowableValues) - Static method in class springfox.documentation.builders.EnumerationElementFacetBuilder

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

G

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

getAccepts() - Method in class springfox.documentation.builders.ParameterSpecificationContext

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

getAllowedValues() - Method in class springfox.documentation.schema.EnumerationFacet

getAllowedValues() - Method in class springfox.documentation.service.ServerVariable

getAllowEmptyValue() - Method in class springfox.documentation.schema.PropertySpecification

getAllowEmptyValue() - Method in class springfox.documentation.service.SimpleParameterSpecification

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

Deprecated.

getAllowReserved() - Method in class springfox.documentation.service.Encoding

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

Deprecated.

getAllowReserved() - Method in class springfox.documentation.service.SimpleParameterSpecification

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

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

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

getAuthorizationUrl() - Method in class springfox.documentation.service.OAuth2Scheme

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

Deprecated.

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

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

getBearerFormat() - Method in class springfox.documentation.service.HttpAuthenticationScheme

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

getClassName() - Method in class springfox.documentation.common.ClassNotPresentInClassPathCondition

getClassName() - Method in class springfox.documentation.common.ClassPresentInClassPathCondition

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

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

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

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

Deprecated.

getCollection() - Method in class springfox.documentation.schema.ModelSpecification

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

Deprecated.

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

getCollectionType() - Method in class springfox.documentation.schema.CollectionSpecification

getCompound() - Method in class springfox.documentation.schema.ModelSpecification

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

getContent() - Method in class springfox.documentation.service.ParameterSpecification

getContentParameter() - Method in class springfox.documentation.builders.ParameterSpecificationContext

getContentSpecificationBuilder() - Method in class springfox.documentation.builders.ParameterSpecificationContext

getContentType() - Method in class springfox.documentation.service.Encoding

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

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

Deprecated.

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

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

Deprecated.

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

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

getDeprecated() - Method in class springfox.documentation.schema.ModelFacets

getDeprecated() - Method in class springfox.documentation.schema.PropertySpecification

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

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

getDescription() - Method in class springfox.documentation.common.ExternalDocumentation

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

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

Deprecated.

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

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

Deprecated.

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

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.CollectionFormat

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

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

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

Deprecated.

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

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

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

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

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

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

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

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

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

Deprecated.

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

getEncodings() - Method in class springfox.documentation.service.Representation

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

Deprecated.

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

Deprecated.

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

getExamples() - Method in class springfox.documentation.schema.ModelFacets

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

Deprecated.

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

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

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

Deprecated.

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

getExclusiveMaximum() - Method in class springfox.documentation.schema.NumericElementFacet

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

getExclusiveMinimum() - Method in class springfox.documentation.schema.NumericElementFacet

getExplode() - Method in class springfox.documentation.service.Encoding

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

Deprecated.

getExplode() - Method in class springfox.documentation.service.SimpleParameterSpecification

getExtensions() - Method in class springfox.documentation.common.ExternalDocumentation

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

getExtensions() - Method in class springfox.documentation.schema.ModelFacets

getExtensions() - Method in class springfox.documentation.service.DocumentationReference

getExtensions() - Method in class springfox.documentation.service.Encoding

getExtensions() - Method in class springfox.documentation.service.RequestBody

getExtensions() - Method in class springfox.documentation.service.RequestParameter

getExtensions() - Method in class springfox.documentation.service.Server

getExtensions() - Method in class springfox.documentation.service.ServerVariable

getExternalDocumentation() - Method in class springfox.documentation.schema.ModelFacets

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

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

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

getFacetExamples() - Method in class springfox.documentation.schema.ModelSpecification

getFacetExtensions() - Method in class springfox.documentation.schema.ModelSpecification

getFacets() - Method in class springfox.documentation.schema.ModelFacets

getFacets() - Method in class springfox.documentation.schema.ModelSpecification

getFacets() - Method in class springfox.documentation.schema.PropertySpecification

getFacets() - Method in class springfox.documentation.service.SimpleParameterSpecification

getField() - Method in class springfox.documentation.builders.ValidationResult

getFlowType() - Method in class springfox.documentation.service.OAuth2Scheme

getFormat() - Method in class springfox.documentation.schema.ScalarType

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.Encoding

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

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

Deprecated.

getHidden() - Method in class springfox.documentation.schema.PropertySpecification

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

Deprecated.

getHidden() - Method in class springfox.documentation.service.RequestParameter

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

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

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

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

Deprecated.

getIn() - Method in class springfox.documentation.builders.ParameterSpecificationContext

getIn() - Method in enum springfox.documentation.service.ParameterType

getIn() - Method in class springfox.documentation.service.RequestParameter

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

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

Deprecated.

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

Deprecated.

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

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

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

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

getLeft() - Method in class springfox.documentation.common.Either

getLegacy() - Method in class springfox.documentation.common.Compatibility

getLevel() - Method in class springfox.documentation.builders.ValidationResult

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

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

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

getMap() - Method in class springfox.documentation.schema.ModelSpecification

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

getMaximum() - Method in class springfox.documentation.schema.NumericElementFacet

getMaxItems() - Method in class springfox.documentation.schema.CollectionElementFacet

getMaxLength() - Method in class springfox.documentation.schema.StringElementFacet

getMaxProperties() - Method in class springfox.documentation.schema.CompoundModelSpecification

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

getMediaType() - Method in class springfox.documentation.service.Representation

getMessage() - Method in class springfox.documentation.builders.ValidationResult

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

Deprecated.

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

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

getMinimum() - Method in class springfox.documentation.schema.NumericElementFacet

getMinItems() - Method in class springfox.documentation.schema.CollectionElementFacet

getMinLength() - Method in class springfox.documentation.schema.StringElementFacet

getMinProperties() - Method in class springfox.documentation.schema.CompoundModelSpecification

getModel() - Method in class springfox.documentation.schema.CollectionSpecification

getModel() - Method in class springfox.documentation.service.Representation

getModel() - Method in class springfox.documentation.service.SimpleParameterSpecification

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

Deprecated.

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

Deprecated.

getModelKey() - Method in class springfox.documentation.schema.CompoundModelSpecification

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

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

Deprecated.

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

Deprecated.

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

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

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

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

getModern() - Method in class springfox.documentation.common.Compatibility

getMultipleOf() - Method in class springfox.documentation.schema.NumericElementFacet

getName() - Method in class springfox.documentation.builders.ParameterSpecificationContext

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

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

Deprecated.

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

Deprecated.

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

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

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

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

Deprecated.

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

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

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

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

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

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

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

getName() - Method in interface springfox.documentation.spring.wrapper.NameValueExpression

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

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

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

getNullable() - Method in class springfox.documentation.schema.ModelFacets

getNullable() - Method in class springfox.documentation.schema.PropertySpecification

getObject() - Method in class springfox.documentation.builders.ValidationResult

getOpenIdConnectUrl() - Method in class springfox.documentation.service.OpenIdConnectScheme

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.Operation

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

Deprecated.

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

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

getOriginalInfo() - Method in interface springfox.documentation.spring.wrapper.RequestMappingInfo

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

Deprecated.

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

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

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

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

getParameterSpecification() - Method in class springfox.documentation.service.RequestParameter

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

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

Deprecated.

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

Deprecated.

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

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

Deprecated.

getPatterns() - Method in interface springfox.documentation.spring.wrapper.PatternsRequestCondition

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

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

Deprecated.

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

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

getPrecedence() - Method in class springfox.documentation.service.RequestParameter

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.CompoundModelSpecification

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

Deprecated.

getPropertyRef() - Method in class springfox.documentation.service.Encoding

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

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

getQualifiedModelName() - Method in class springfox.documentation.schema.ModelKey

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

Deprecated.

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

Deprecated.

getQuery() - Method in class springfox.documentation.service.ParameterSpecification

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

getReadOnly() - Method in class springfox.documentation.schema.PropertySpecification

getReference() - Method in class springfox.documentation.schema.ModelSpecification

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

getRefreshUrl() - Method in class springfox.documentation.service.OAuth2Scheme

getRepresentations() - Method in class springfox.documentation.service.ContentSpecification

getRepresentations() - Method in class springfox.documentation.service.RequestBody

getRepresentations() - Method in class springfox.documentation.service.Response

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

Deprecated.

This is introduced to preserve backwards compat

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

getRequired() - Method in class springfox.documentation.schema.PropertySpecification

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

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

Deprecated.

getRequired() - Method in class springfox.documentation.service.RequestBody

getRequired() - Method in class springfox.documentation.service.RequestParameter

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

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

getRight() - Method in class springfox.documentation.common.Either

getScalar() - Method in class springfox.documentation.schema.ModelSpecification

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

Deprecated.

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

getScheme() - Method in class springfox.documentation.service.HttpAuthenticationScheme

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.OAuth2Scheme

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

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

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

getSimpleParameter() - Method in class springfox.documentation.builders.ParameterSpecificationContext

getSimpleParameterSpecificationBuilder() - Method in class springfox.documentation.builders.ParameterSpecificationContext

getStyle() - Method in class springfox.documentation.service.Encoding

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

Deprecated.

getStyle() - Method in class springfox.documentation.service.SimpleParameterSpecification

getSubclassReferences() - Method in class springfox.documentation.schema.CompoundModelSpecification

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

Deprecated.

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

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

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.schema.ModelFacets

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

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

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

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

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

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

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

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

Deprecated.

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

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

Deprecated.

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

Deprecated.

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

getUniqueItems() - Method in class springfox.documentation.schema.CollectionElementFacet

getUrl() - Method in class springfox.documentation.common.ExternalDocumentation

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

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

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

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

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

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

getValidationGroupDiscriminators() - Method in class springfox.documentation.schema.ModelKey

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

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

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

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

getValue() - Method in enum springfox.documentation.service.ParameterStyle

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

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

getValue() - Method in interface springfox.documentation.spring.wrapper.NameValueExpression

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

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

getVariables() - Method in class springfox.documentation.service.Server

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

Deprecated.

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

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.Parameter

Deprecated.

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

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

Deprecated.

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

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

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

Deprecated.

getVersion() - Method in class springfox.documentation.common.SpringVersion

Return the full version string of the present Spring codebase, or null if it cannot be determined.

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

getViewDiscriminator() - Method in class springfox.documentation.schema.ModelKey

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

getWriteOnly() - Method in class springfox.documentation.schema.PropertySpecification

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

Deprecated.

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

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

Deprecated.

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

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() - Method in interface springfox.documentation.RequestHandler

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

Updates the group name the api operation belongs to

H

hashCode() - Method in class springfox.documentation.common.Compatibility

hashCode() - Method in class springfox.documentation.common.Either

hashCode() - Method in class springfox.documentation.common.ExternalDocumentation

hashCode() - Method in class springfox.documentation.common.Version

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

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

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

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

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

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

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

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

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

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

Deprecated.

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

Deprecated.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Deprecated.

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

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

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

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, ModelSpecification) - Constructor for class springfox.documentation.service.Header

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

HEADER - springfox.documentation.service.ParameterType

HeaderParameterSpecificationProvider - Class in springfox.documentation.builders

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

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

headers(Collection<Header>) - Method in class springfox.documentation.builders.EncodingBuilder

headers(Collection<Header>) - Method in class springfox.documentation.builders.ResponseBuilder

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

Deprecated.

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

Deprecated.

Updates if the parameter is hidden

hidden(Boolean) - Method in class springfox.documentation.builders.RequestParameterBuilder

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.

HttpAuthenticationBuilder - Class in springfox.documentation.builders

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

HttpAuthenticationScheme - Class in springfox.documentation.service

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

I

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

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

in(String) - Method in class springfox.documentation.builders.RequestParameterBuilder

in(ParameterType) - Method in class springfox.documentation.builders.RequestParameterBuilder

Incubating - Annotation Type in springfox.documentation.annotations

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

Updates the api information

INTEGER - Static variable in class springfox.documentation.schema.ScalarType

is(Version) - Method in class springfox.documentation.common.Version

Returns whether the current Version is the same as the given one.

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

Deprecated.

Support for isAllowEmpty value

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

Deprecated.

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

Deprecated.

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

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

Deprecated.

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

Deprecated.

isDefault() - Method in class springfox.documentation.service.Response

isDefault(boolean) - Method in class springfox.documentation.builders.ResponseBuilder

isGreaterThan(Version) - Method in class springfox.documentation.common.Version

Returns whether the current Version is greater (newer) than the given one.

isGreaterThanOrEqualTo(Version) - Method in class springfox.documentation.common.Version

Returns whether the current Version is greater (newer) or the same as the given one.

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

Deprecated.

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

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

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

Deprecated.

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

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

isLessThan(Version) - Method in class springfox.documentation.common.Version

Returns whether the current Version is less (older) than the given one.

isLessThanOrEqualTo(Version) - Method in class springfox.documentation.common.Version

Returns whether the current Version is less (older) or equal to the current one.

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

Deprecated.

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

Deprecated.

isNegated() - Method in interface springfox.documentation.spring.wrapper.NameValueExpression

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

Deprecated.

isRequestBody() - Method in class springfox.documentation.service.ContentSpecification

isRequestBody() - Method in class springfox.documentation.service.RequestParameter

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

Deprecated.

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

Deprecated.

isResponse() - Method in class springfox.documentation.schema.ModelKey

isResponse(boolean) - Method in class springfox.documentation.schema.ModelKeyBuilder

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

Deprecated.

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

Deprecated.

J

JWT_BEARER_BUILDER - Static variable in class springfox.documentation.service.HttpAuthenticationScheme

K

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

key() - Method in class springfox.documentation.schema.ModelSpecification

key(Consumer<ModelSpecificationBuilder>) - Method in class springfox.documentation.builders.MapSpecificationBuilder

key(Consumer<ModelKeyBuilder>) - Method in class springfox.documentation.builders.ReferenceModelSpecificationBuilder

L

LABEL - springfox.documentation.service.ParameterStyle

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

LIST - springfox.documentation.schema.CollectionType

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

LONG - Static variable in class springfox.documentation.schema.ScalarType

M

mapModel(Consumer<MapSpecificationBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder

Provides a consumer to build the map model.

mapModelIfExists(Consumer<MapSpecificationBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder

Conditionally provides a consumer to build the map model.

MapSpecification - Class in springfox.documentation.schema

MapSpecification(ModelSpecification, ModelSpecification) - Constructor for class springfox.documentation.schema.MapSpecification

MapSpecificationBuilder - Class in springfox.documentation.builders

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

matches(ConditionContext, AnnotatedTypeMetadata) - Method in class springfox.documentation.common.ClassNotPresentInClassPathCondition

matches(ConditionContext, AnnotatedTypeMetadata) - Method in class springfox.documentation.common.ClassPresentInClassPathCondition

MATRIX - springfox.documentation.service.ParameterStyle

maximum(BigDecimal) - Method in class springfox.documentation.schema.NumericElementFacetBuilder

maxItems(Integer) - Method in class springfox.documentation.builders.CollectionElementFacetBuilder

maxLength(Integer) - Method in class springfox.documentation.builders.StringElementFacetBuilder

maxProperties(Integer) - Method in class springfox.documentation.builders.CompoundModelSpecificationBuilder

Provides override for the max properties.

maybeConvertToScalar(ScalarType) - Method in class springfox.documentation.builders.ModelSpecificationBuilder

This is an experimental API.

mediaType(String) - Method in class springfox.documentation.builders.ExampleBuilder

mediaType(String) - Method in class springfox.documentation.builders.RepresentationBuilder

mediaType(MediaType) - Method in class springfox.documentation.builders.RepresentationBuilder

MediaTypes - Class in springfox.documentation.service

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

Deprecated.

Updates the response message

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

Updates the http method

minimum(BigDecimal) - Method in class springfox.documentation.schema.NumericElementFacetBuilder

minItems(Integer) - Method in class springfox.documentation.builders.CollectionElementFacetBuilder

minLength(Integer) - Method in class springfox.documentation.builders.StringElementFacetBuilder

minProperties(Integer) - Method in class springfox.documentation.builders.CompoundModelSpecificationBuilder

Provides override for the min properties.

model(Consumer<ModelSpecificationBuilder>) - Method in class springfox.documentation.builders.CollectionSpecificationBuilder

model(Consumer<ModelSpecificationBuilder>) - Method in class springfox.documentation.builders.RepresentationBuilder

model(Consumer<ModelSpecificationBuilder>) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder

Provides consumer to help build models

Model - Class in springfox.documentation.schema

Deprecated.

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

Deprecated.

ModelBuilder - Class in springfox.documentation.builders

Deprecated.

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

Deprecated.

Constructor with the Id of the model

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

Deprecated.

Constructor with the model

ModelFacets - Class in springfox.documentation.schema

ModelFacets(String, String, Boolean, Boolean, Collection<ElementFacet>, Xml, ExternalDocumentation, List<Example>, List<VendorExtension>) - Constructor for class springfox.documentation.schema.ModelFacets

ModelFacetsBuilder - Class in springfox.documentation.builders

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

modelKey(Consumer<ModelKeyBuilder>) - Method in class springfox.documentation.builders.CompoundModelSpecificationBuilder

Provides a fluent builder consumer for building a model key

ModelKey - Class in springfox.documentation.schema

ModelKey(QualifiedModelName, ResolvedType, Collection<ResolvedType>, boolean) - Constructor for class springfox.documentation.schema.ModelKey

ModelKeyBuilder - Class in springfox.documentation.schema

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

modelNamesRegistry(ModelNamesRegistry) - Method in class springfox.documentation.builders.ApiListingBuilder

ModelNamesRegistry - Interface in springfox.documentation.service

ModelProperty - Class in springfox.documentation.schema

Deprecated.

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

Deprecated.

ModelPropertyBuilder - Class in springfox.documentation.builders

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

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

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

ModelReference - Interface in springfox.documentation.schema

Deprecated.

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

Adds to the models collection

modelsByName() - Method in interface springfox.documentation.service.ModelNamesRegistry

ModelSpecification - Class in springfox.documentation.schema

ModelSpecification(String, ModelFacets, ScalarModelSpecification, CompoundModelSpecification, CollectionSpecification, MapSpecification, ReferenceModelSpecification) - Constructor for class springfox.documentation.schema.ModelSpecification

ModelSpecificationBuilder - Class in springfox.documentation.builders

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

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

Adds to the models collection

MULTI - Static variable in class springfox.documentation.service.CollectionFormat

MultipartFormDataParameterSpecificationProvider - Class in springfox.documentation.builders

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

multipleOf(BigDecimal) - Method in class springfox.documentation.schema.NumericElementFacetBuilder

N

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

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

Name of the documentation group

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

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

Deprecated.

Updates the Name of the model

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

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

Updates the name of the model

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

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.OpenIdConnectSchemeBuilder

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

Deprecated.

Updates the parameter name

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

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

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

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

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

nameByKey(ModelKey) - Method in interface springfox.documentation.service.ModelNamesRegistry

namespace(String) - Method in class springfox.documentation.builders.QualifiedModelNameBuilder

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

NameValueExpression<T> - Interface in springfox.documentation.spring.wrapper

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

NONE - Static variable in class springfox.documentation.service.CollectionFormat

NoopValidator<T> - Class in springfox.documentation.builders

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

NOT - springfox.documentation.service.Qualifier

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

Updates the operation notes

nullable(Boolean) - Method in class springfox.documentation.builders.ModelFacetsBuilder

nullable(Boolean) - Method in class springfox.documentation.builders.PropertySpecificationBuilder

nullSafeIsExplode() - Method in class springfox.documentation.service.SimpleParameterSpecification

nullSafeIsRequired() - Method in class springfox.documentation.schema.PropertySpecification

nullToEmpty(String) - Static method in class springfox.documentation.builders.BuilderDefaults

nullToEmptyArray(T[]) - Static method in class springfox.documentation.builders.BuilderDefaults

Returns an empty list if the newValue is null

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(Map<K, List<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

NumericElementFacet - Class in springfox.documentation.schema

NumericElementFacet(BigDecimal, BigDecimal, Boolean, BigDecimal, Boolean) - Constructor for class springfox.documentation.schema.NumericElementFacet

NumericElementFacetBuilder - Class in springfox.documentation.schema

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

numericFacet(Consumer<NumericElementFacetBuilder>) - Method in class springfox.documentation.builders.ModelFacetsBuilder

numericFacet(Consumer<NumericElementFacetBuilder>) - Method in class springfox.documentation.builders.PropertySpecificationBuilder

numericFacet(Consumer<NumericElementFacetBuilder>) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder

Provides consumer to help build numeric element facet

O

OAuth - Class in springfox.documentation.service

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

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

OAUTH2_AUTHORIZATION_CODE_FLOW_BUILDER - Static variable in class springfox.documentation.service.OAuth2Scheme

OAUTH2_CLIENT_CREDENTIALS_FLOW_BUILDER - Static variable in class springfox.documentation.service.OAuth2Scheme

OAUTH2_IMPLICIT_FLOW_BUILDER - Static variable in class springfox.documentation.service.OAuth2Scheme

OAUTH2_PASSWORD_FLOW_BUILDER - Static variable in class springfox.documentation.service.OAuth2Scheme

OAuth2Scheme - Class in springfox.documentation.service

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

OAuth2SchemeBuilder - Class in springfox.documentation.builders

OAuth2SchemeBuilder(String) - Constructor for class springfox.documentation.builders.OAuth2SchemeBuilder

OAuth2SchemeValidator<T> - Class in springfox.documentation.builders

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

OAuthBuilder - Class in springfox.documentation.builders

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

OBJECT - Static variable in class springfox.documentation.schema.ScalarType

ObjectVendorExtension - Class in springfox.documentation.service

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

ONE_OF - springfox.documentation.service.Qualifier

OpenIdConnectScheme - Class in springfox.documentation.service

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

OpenIdConnectSchemeBuilder - Class in springfox.documentation.builders

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

openIdConnectUrl(String) - Method in class springfox.documentation.builders.OpenIdConnectSchemeBuilder

Operation - Class in springfox.documentation.service

Operation(HttpMethod, String, String, ExternalDocumentation, ModelReference, String, int, Set<String>, Set<String>, Set<String>, Set<String>, List<SecurityReference>, List<Parameter>, Set<ResponseMessage>, String, boolean, Collection<VendorExtension>, Set<RequestParameter>, RequestBody, Set<Response>) - 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

Deprecated.

Updates default order of precedence of parameters

P

Parameter - Class in springfox.documentation.service

Deprecated.

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

Deprecated.

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

Deprecated.

Updates the parameter access

ParameterBuilder - Class in springfox.documentation.builders

Deprecated.

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

Deprecated.

parameterIndex(int) - Method in class springfox.documentation.builders.RequestParameterBuilder

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

Deprecated.

ParameterSpecification - Class in springfox.documentation.service

ParameterSpecification(SimpleParameterSpecification, ContentSpecification) - Constructor for class springfox.documentation.service.ParameterSpecification

ParameterSpecificationContext - Class in springfox.documentation.builders

ParameterSpecificationContext(String, ParameterType, Collection<MediaType>, SimpleParameterSpecification, ContentSpecification, SimpleParameterSpecificationBuilder, ContentSpecificationBuilder) - Constructor for class springfox.documentation.builders.ParameterSpecificationContext

parameterSpecificationProvider(ParameterSpecificationProvider) - Method in class springfox.documentation.builders.RequestParameterBuilder

ParameterSpecificationProvider - Interface in springfox.documentation.builders

ParameterStyle - Enum in springfox.documentation.service

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

Deprecated.

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

Deprecated.

Updates the type of parameter

ParameterType - Enum in springfox.documentation.service

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

parse(String) - Static method in class springfox.documentation.common.Version

Parses the given string representation of a version into a Version object.

PASSWORD - Static variable in class springfox.documentation.schema.ScalarType

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

Updates the path to the api operation

PATH - springfox.documentation.service.ParameterType

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

PathParameterSpecificationProvider - Class in springfox.documentation.builders

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

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

Deprecated.

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

PatternsRequestCondition<T> - Interface in springfox.documentation.spring.wrapper

PIPEDELIMITED - springfox.documentation.service.ParameterStyle

PIPES - Static variable in class springfox.documentation.service.CollectionFormat

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

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

precedence(int) - Method in class springfox.documentation.builders.RequestParameterBuilder

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

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

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

properties(Collection<PropertySpecification>) - Method in class springfox.documentation.builders.CompoundModelSpecificationBuilder

Copies existing set of properties

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

Deprecated.

Updates the model properties

property(String) - Method in class springfox.documentation.builders.CompoundModelSpecificationBuilder

Provides method to create a property with given name

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

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

Deprecated.

propertyIfExists(String) - Method in class springfox.documentation.builders.CompoundModelSpecificationBuilder

Provides method to maybe create a property with given name.

PropertySpecification - Class in springfox.documentation.schema

PropertySpecification(String, String, ModelSpecification, List<ElementFacet>, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, int, Object, Object, Xml, List<VendorExtension>) - Constructor for class springfox.documentation.schema.PropertySpecification

PropertySpecificationBuilder - Class in springfox.documentation.builders

PropertySpecificationBuilder(String) - Constructor for class springfox.documentation.builders.PropertySpecificationBuilder

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

qualifiedModelName(Consumer<QualifiedModelNameBuilder>) - Method in class springfox.documentation.schema.ModelKeyBuilder

qualifiedModelName(QualifiedModelName) - Method in class springfox.documentation.schema.ModelKeyBuilder

QualifiedModelName - Class in springfox.documentation.schema

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

QualifiedModelNameBuilder - Class in springfox.documentation.builders

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

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

Deprecated.

Fully package qualified name of the model

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

Qualifier - Enum in springfox.documentation.service

query(Consumer<SimpleParameterSpecificationBuilder>) - Method in class springfox.documentation.builders.RequestParameterBuilder

QUERY - springfox.documentation.service.ParameterType

R

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

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

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

Updates the authorization reference for the api.

referenceModel(Consumer<ReferenceModelSpecificationBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder

Provides a consumer to build the reference model.

referenceModelIfExists(Consumer<ReferenceModelSpecificationBuilder>) - Method in class springfox.documentation.builders.ModelSpecificationBuilder

Provides a consumer to build the reference model.

ReferenceModelSpecification - Class in springfox.documentation.schema

ReferenceModelSpecification(ModelKey) - Constructor for class springfox.documentation.schema.ReferenceModelSpecification

ReferenceModelSpecificationBuilder - Class in springfox.documentation.builders

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

refreshUrl(String) - Method in class springfox.documentation.builders.OAuth2SchemeBuilder

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

representation(MediaType) - Method in class springfox.documentation.builders.ContentSpecificationBuilder

representation(MediaType) - Method in class springfox.documentation.builders.ResponseBuilder

Representation - Class in springfox.documentation.service

Representation(MediaType, ModelSpecification, Set<Encoding>) - Constructor for class springfox.documentation.service.Representation

RepresentationBuilder - Class in springfox.documentation.builders

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

representationFor(MediaType) - Method in class springfox.documentation.service.ContentSpecification

requestBody(boolean) - Method in class springfox.documentation.builders.ContentSpecificationBuilder

requestBody(RequestBody) - Method in class springfox.documentation.builders.OperationBuilder

Updates the operation request body.

RequestBody - Class in springfox.documentation.service

RequestBody(String, Set<Representation>, Boolean, List<VendorExtension>) - Constructor for class springfox.documentation.service.RequestBody

RequestHandler - Interface in springfox.documentation

RequestHandlerKey - Class in springfox.documentation

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

RequestHandlerSelectors - Class in springfox.documentation.builders

RequestMappingInfo<T> - Interface in springfox.documentation.spring.wrapper

RequestParameter - Class in springfox.documentation.service

RequestParameter(String, ParameterType, String, Boolean, Boolean, Boolean, ParameterSpecification, Example, Collection<Example>, int, List<VendorExtension>, int) - Constructor for class springfox.documentation.service.RequestParameter

RequestParameterBuilder - Class in springfox.documentation.builders

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

RequestParameterBuilderValidator - Class in springfox.documentation.builders

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

requestParameters(Collection<RequestParameter>) - Method in class springfox.documentation.builders.OperationBuilder

Updates the operation response body

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

Deprecated.

Updates if the parameter is required or optional

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

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

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

ResolvedMethodParameter - Class in springfox.documentation.service

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

ResolvedMethodParameter(String, MethodParameter, 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(Consumer<ResourceListingBuilder>) - Method in class springfox.documentation.builders.DocumentationBuilder

Updates the resource listing

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

Deprecated.

ResourceListing - Class in springfox.documentation.service

ResourceListing(String, List<ApiListingReference>, List<SecurityScheme>, ApiInfo, Collection<Server>) - 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

Response - Class in springfox.documentation.service

Response(String, String, boolean, Collection<Header>, Collection<Representation>, Collection<Example>, Collection<VendorExtension>) - Constructor for class springfox.documentation.service.Response

ResponseBuilder - Class in springfox.documentation.builders

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

ResponseMessage - Class in springfox.documentation.service

Deprecated.

- Use @see Response instead going forward

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

Deprecated.

ResponseMessageBuilder - Class in springfox.documentation.builders

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

Updates the model the response represents

responses(Collection<Response>) - Method in class springfox.documentation.builders.OperationBuilder

Updates the response messages

RootParameterSpecificationProvider - Class in springfox.documentation.builders

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

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

S

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

Deprecated.

scalarModel(ScalarType) - Method in class springfox.documentation.builders.ModelSpecificationBuilder

Updates the scalar type

ScalarModelSpecification - Class in springfox.documentation.schema

ScalarModelSpecification(ScalarType) - Constructor for class springfox.documentation.schema.ScalarModelSpecification

ScalarType - Class in springfox.documentation.schema

ScalarTypes - Class in springfox.documentation.schema

scheme(String) - Method in class springfox.documentation.builders.HttpAuthenticationBuilder

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.OAuth2SchemeBuilder

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

SecurityReferenceBuilder() - Constructor for class springfox.documentation.service.SecurityReference.SecurityReferenceBuilder

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

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

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

Updates the security definitions that protect this resource listing

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

Adds servers information for this API

Server - Class in springfox.documentation.service

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

ServerBuilder - Class in springfox.documentation.builders

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

servers(Collection<Server>) - Method in class springfox.documentation.builders.ResourceListingBuilder

ServerVariable - Class in springfox.documentation.service

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

ServerVariableBuilder - Class in springfox.documentation.builders

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

SET - springfox.documentation.schema.CollectionType

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

SIMPLE - springfox.documentation.service.ParameterStyle

SimpleParameterSpecification - Class in springfox.documentation.service

SimpleParameterSpecification(ParameterStyle, CollectionFormat, Boolean, Boolean, Boolean, String, ModelSpecification, List<ElementFacet>) - Constructor for class springfox.documentation.service.SimpleParameterSpecification

SimpleParameterSpecificationBuilder - Class in springfox.documentation.builders

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

sortedPaths(PatternsRequestCondition) - Static method in interface springfox.documentation.RequestHandler

SPACEDELIMITED - springfox.documentation.service.ParameterStyle

springfox.documentation - package springfox.documentation

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

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

springfox.documentation.common - package springfox.documentation.common

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

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

springfox.documentation.spring.wrapper - package springfox.documentation.spring.wrapper

SpringVersion - Class in springfox.documentation.common

Class providing a proxy for @SpringVersion This enable mocking and testing of specific situations

SpringVersion() - Constructor for class springfox.documentation.common.SpringVersion

SpringVersionCapability - Class in springfox.documentation.common

SSV - Static variable in class springfox.documentation.service.CollectionFormat

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

STRING - Static variable in class springfox.documentation.schema.ScalarType

StringElementFacet - Class in springfox.documentation.schema

StringElementFacet(Integer, Integer, String) - Constructor for class springfox.documentation.schema.StringElementFacet

StringElementFacetBuilder - Class in springfox.documentation.builders

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

stringFacet(Consumer<StringElementFacetBuilder>) - Method in class springfox.documentation.builders.ModelFacetsBuilder

stringFacet(Consumer<StringElementFacetBuilder>) - Method in class springfox.documentation.builders.PropertySpecificationBuilder

stringFacet(Consumer<StringElementFacetBuilder>) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder

Provides consumer to help build string element facet

StringVendorExtension - Class in springfox.documentation.service

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

style(ParameterStyle) - Method in class springfox.documentation.builders.EncodingBuilder

style(ParameterStyle) - Method in class springfox.documentation.builders.ParameterBuilder

Deprecated.

style(ParameterStyle) - Method in class springfox.documentation.builders.SimpleParameterSpecificationBuilder

Parameter style

subclassReferences(Collection<ReferenceModelSpecification>) - Method in class springfox.documentation.builders.CompoundModelSpecificationBuilder

References to subclasses

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

Deprecated.

Updates the subclasses for this model.

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

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

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

Updates the operation summary

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

supportsExtendedPathVariableAnnotation(Version) - Static method in class springfox.documentation.common.SpringVersionCapability

supportsXForwardPrefixHeader(Version) - Static method in class springfox.documentation.common.SpringVersionCapability

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, int, List<VendorExtension>) - Constructor for class springfox.documentation.service.Tag

Tag(String, String, 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<String>) - Method in class springfox.documentation.builders.OperationBuilder

Updates the tags that identify this operation

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 - 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

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

tokenEndpoint(Consumer<TokenEndpointBuilder>) - Method in class springfox.documentation.builders.AuthorizationCodeGrantBuilder

Updates token endpoint

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

Deprecated.

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(Consumer<TokenRequestEndpointBuilder>) - Method in class springfox.documentation.builders.AuthorizationCodeGrantBuilder

Updates token request endpoint

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

Deprecated.

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

tokenUrl(String) - Method in class springfox.documentation.builders.OAuth2SchemeBuilder

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

toString() - Method in class springfox.documentation.common.ExternalDocumentation

toString() - Method in class springfox.documentation.common.Version

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Deprecated.

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

toString() - Method in enum springfox.documentation.service.ParameterStyle

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

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

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

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

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

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

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

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

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

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

TSV - Static variable in class springfox.documentation.service.CollectionFormat

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

Deprecated.

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

Deprecated.

Updates the type of parameter

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

type(ModelSpecification) - Method in class springfox.documentation.builders.PropertySpecificationBuilder

U

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

Updates the uniqueId for the operation.

uniqueItems(Boolean) - Method in class springfox.documentation.builders.CollectionElementFacetBuilder

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

Deprecated.

URI - Static variable in class springfox.documentation.schema.ScalarType

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

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

Updates the url for the login endpoint

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

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

URL - Static variable in class springfox.documentation.schema.ScalarType

UUID - Static variable in class springfox.documentation.schema.ScalarType

V

validate(OAuth2SchemeBuilder) - Method in class springfox.documentation.builders.OAuth2SchemeValidator

validate(RequestParameterBuilder) - Method in class springfox.documentation.builders.RequestParameterBuilderValidator

validate(T) - Method in class springfox.documentation.builders.NoopValidator

validate(T) - Method in interface springfox.documentation.builders.Validator

validationGroupDiscriminators(Collection<ResolvedType>) - Method in class springfox.documentation.schema.ModelKeyBuilder

ValidationResult - Class in springfox.documentation.builders

ValidationResult(String, String, String) - Constructor for class springfox.documentation.builders.ValidationResult

ValidationResult(Level, String, String, String) - Constructor for class springfox.documentation.builders.ValidationResult

validator(Validator<OAuth2SchemeBuilder>) - Method in class springfox.documentation.builders.OAuth2SchemeBuilder

validator(Validator<RequestParameterBuilder>) - Method in class springfox.documentation.builders.RequestParameterBuilder

Validator<T> - Interface in springfox.documentation.builders

value() - Method in annotation type springfox.documentation.annotations.ApiIgnore

A brief description of why this parameter/operation is ignored

value() - Method in annotation type springfox.documentation.annotations.Cacheable

value() - Method in annotation type springfox.documentation.annotations.Incubating

To keep track of which version this incubating feature was introduced

value(Object) - Method in class springfox.documentation.builders.ExampleBuilder

value(Consumer<ModelSpecificationBuilder>) - Method in class springfox.documentation.builders.MapSpecificationBuilder

valueOf(String) - Static method in enum springfox.documentation.schema.CollectionType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum springfox.documentation.service.ParameterStyle

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum springfox.documentation.service.ParameterType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum springfox.documentation.service.Qualifier

Returns the enum constant of this type with the specified name.

values() - Static method in enum springfox.documentation.schema.CollectionType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum springfox.documentation.service.ParameterStyle

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum springfox.documentation.service.ParameterType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum springfox.documentation.service.Qualifier

Returns an array containing the constants of this enum type, in the order they are declared.

variables(Collection<ServerVariable>) - Method in class springfox.documentation.builders.ServerBuilder

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

vendorExtensions(Collection<VendorExtension>) - Method in class springfox.documentation.builders.EncodingBuilder

vendorExtensions(Collection<VendorExtension>) - Method in class springfox.documentation.builders.ResponseBuilder

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

Deprecated.

Updates the parameter extensions

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

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

Deprecated.

Updates the response message extensions

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

Updates the api version

Version - Class in springfox.documentation.common

Value object to represent a Version consisting of major, minor and bugfix part.

Version(int...) - Constructor for class springfox.documentation.common.Version

Creates a new Version from the given integer values.

viewDiscriminator(ResolvedType) - Method in class springfox.documentation.schema.ModelKeyBuilder

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

Deprecated.

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

withDescription(String) - Method in class springfox.documentation.builders.ExampleBuilder

Deprecated.

withExternalValue(String) - Method in class springfox.documentation.builders.ExampleBuilder

Deprecated.

withId(String) - Method in class springfox.documentation.builders.ExampleBuilder

Deprecated.

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

Deprecated.

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

Deprecated.

withSummary(String) - Method in class springfox.documentation.builders.ExampleBuilder

Deprecated.

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

Deprecated.

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

writeOnly(Boolean) - Method in class springfox.documentation.builders.PropertySpecificationBuilder

X

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

Deprecated.

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

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

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

Xml - Class in springfox.documentation.schema

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

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