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

A

AllowableListValues - Class in springfox.documentation.service

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

AllowableRangeValues - Class in springfox.documentation.service

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

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

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

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

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

AllowableValues - Interface in springfox.documentation.service

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

Updates if the parameter should allow multiple values

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

Provides alternate for supplier type.

AlternateTypeRule - Class in springfox.documentation.schema

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

Instantiates a new Alternate type rule.

AlternateTypeRules - Class in springfox.documentation.schema

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

Predicate that evaluates the supplied ant pattern

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

Any path satisfies this condition

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

Any RequestHandler satisfies this condition

ApiDescription - Class in springfox.documentation.service

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

ApiDescriptionBuilder - Class in springfox.documentation.builders

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

ApiIgnore - Annotation Type in springfox.documentation.annotations

ApiInfo - Class in springfox.documentation.service

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

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

ApiListing - Class in springfox.documentation.service

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

ApiListingBuilder - Class in springfox.documentation.builders

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

Update the sorting order for api descriptions

ApiListingReference - Class in springfox.documentation.service

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

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

Updates the map with new entries

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

Updates the apis

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

Updates the api listed within this resource listing

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

Updates the api version

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

Updates the api version

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

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

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

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

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

Check if an alternate applies to type.

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(List<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

B

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

Update the based model

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

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

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

Updates base path for the api listing

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

Base path for this API

BasicAuth - Class in springfox.documentation.service

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

BuilderDefaults - Class in springfox.documentation.builders

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

C

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

Updates the client id name

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

Updates the client secret name

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

Updates the http response code

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

Updates contact information for the person responsible for this API

D

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

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

Returns this default value if the new value is null

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

Updates the default value of the parametr

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

Marks the listing as deprecated

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

Updates the descriptions to the api operation

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

Updates the api description

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

Updates the description

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

Updates the description of the scope

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

Update the description of the model

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

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

Updates the description of the parameter

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

Updates inheritance discriminator, used to identify inherited subclasses.

Documentation - Class in springfox.documentation.service

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

DocumentationBuilder - Class in springfox.documentation.builders

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

E

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

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

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

Enums - Class in springfox.documentation.schema

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

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

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

G

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

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

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

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

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

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

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

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

Gets the application base path

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Gets the resource listing path given a group name and api

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

H

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

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

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

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

I

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

Updates the Id of the model, usually the type name

ImplicitGrant - Class in springfox.documentation.service

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

ImplicitGrantBuilder - Class in springfox.documentation.builders

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

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

Updates the api information

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

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

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

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

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

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

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

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

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

L

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

Updates license information for this API

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

Updates the license Url for this API

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

Updates the login endpoint

LoginEndpoint - Class in springfox.documentation.service

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

LoginEndpointBuilder - Class in springfox.documentation.builders

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

M

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

Updates the response message

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

Updates the http method

Model - Class in springfox.documentation.schema

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

ModelBuilder - Class in springfox.documentation.builders

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

ModelProperty - Class in springfox.documentation.schema

ModelProperty(String, ResolvedType, String, int, Boolean, boolean, String, AllowableValues) - Constructor for class springfox.documentation.schema.ModelProperty

ModelPropertyBuilder - Class in springfox.documentation.builders

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

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

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

ModelRef - Class in springfox.documentation.schema

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

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

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

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

Adds to the models collection

N

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

Name of the documentation group

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

Updates the Name of the model

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

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

Updates the unique name to identify the security definition

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

Updates the parameter name

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

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.

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

No path satisfies this condition

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

No RequestHandler satisfies this condition

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

Updates the operation notes

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

Returns an empty list if the newValue is null

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

Returns an empty map if the input is null

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

Returns an empty map if the input is null

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

Returns an empty set if the newValue is null

O

OAuth - Class in springfox.documentation.service

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

OAuthBuilder - Class in springfox.documentation.builders

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

Operation - Class in springfox.documentation.service

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

OperationBuilder - Class in springfox.documentation.builders

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

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

Updates the operations to the api operation

P

Parameter - Class in springfox.documentation.service

Parameter(String, String, String, boolean, boolean, ModelRef, Optional<ResolvedType>, AllowableValues, String, String) - Constructor for class springfox.documentation.service.Parameter

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

Updates the parameter access

ParameterBuilder - Class in springfox.documentation.builders

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

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

Updates the input parameters this operation needs

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

Updates the type of parameter

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

Updates the path to the api operation

PathProvider - Interface in springfox.documentation

PathSelectors - Class in springfox.documentation.builders

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

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(Map<String, ModelProperty>) - Method in class springfox.documentation.builders.ModelBuilder

Updates the model properties

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

Appends to the exiting collection of supported protocols

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

Update the protocols this operation supports

Q

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

Fully package qualified name of the model

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

R

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

Updates the authorization reference for the api.

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

Predicate that evaluates the supplied regular expression

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

Coalesces the resolved type.

RequestHandler - Class in springfox.documentation

RequestHandler(RequestMappingInfo, HandlerMethod) - Constructor for class springfox.documentation.RequestHandler

RequestHandlerSelectors - Class in springfox.documentation.builders

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

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

Updates if the parameter is required or optional

ResolvedMethodParameter - Class in springfox.documentation.service

ResolvedMethodParameter(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(ResourceListing) - Method in class springfox.documentation.builders.DocumentationBuilder

Updates the resource listing

ResourceListing - Class in springfox.documentation.service

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

ResourceListingBuilder - Class in springfox.documentation.builders

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

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

Updates resource path for the api listing

ResponseMessage - Class in springfox.documentation.service

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

ResponseMessageBuilder - Class in springfox.documentation.builders

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

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

Updates the response messages

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

Updates the reference to the response model

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

Updates the model the response represents

S

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

Updates the schemes this api supports

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

Updates the scope

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

Updates the authorization scopes with the new scopes

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

Updates the authorization scopes that this authorization applies to.

SecurityReference - Class in springfox.documentation.service

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

SecurityReference.SecurityReferenceBuilder - Class in springfox.documentation.service

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

Updates the references to the security definitiosn

SecurityScheme - Class in springfox.documentation.service

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

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

Updates the security definitions that protect this resource listing

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

springfox.documentation - package springfox.documentation

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

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

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

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

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

Updates the subclasses for this model.

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

Updates the operation summary

T

Tag - Class in springfox.documentation.service

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

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

Updates the tags with new entries

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

Updates the tags that identify this operation

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

Updates the terms of service url

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

Updates the api title

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

Updates token endpoint

TokenEndpoint - Class in springfox.documentation.service

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

TokenEndpointBuilder - Class in springfox.documentation.builders

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

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

Updates the token name

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

Updates the token name

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

Updates token request endpoint

TokenRequestEndpoint - Class in springfox.documentation.service

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

TokenRequestEndpointBuilder - Class in springfox.documentation.builders

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

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

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

Represents the type information with full fidelity of generics

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

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

Updates the type of parameter

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

U

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

Updates the uniqueId for the operation

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

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

Updates the url for the login endpoint

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

Updates the token endpoint url

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

Updates the url for the token request endpoint

V

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

Updates the api version

W

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

WildcardType - Class in springfox.documentation.schema

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

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

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

Predicate that matches RequestHandler with handlers methods annotated with given annotation

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