- FieldDescriptor - Class in org.springframework.restdocs.payload
-
A description of a field found in a request or response payload.
- FieldDescriptor(String) - Constructor for class org.springframework.restdocs.payload.FieldDescriptor
-
Creates a new FieldDescriptor
describing the field with the given
path
.
- FieldDoesNotExistException - Exception in org.springframework.restdocs.payload
-
A FieldDoesNotExistException
is thrown when a requested field does not exist in
a payload.
- FieldDoesNotExistException(String) - Constructor for exception org.springframework.restdocs.payload.FieldDoesNotExistException
-
Creates a new FieldDoesNotExistException
that indicates that the field with
the given fieldPath
does not exist.
- FieldPathPayloadSubsectionExtractor - Class in org.springframework.restdocs.payload
-
- FieldPathPayloadSubsectionExtractor(String) - Constructor for class org.springframework.restdocs.payload.FieldPathPayloadSubsectionExtractor
-
Creates a new FieldPathPayloadSubsectionExtractor
that will extract the
subsection of the JSON payload beneath the given fieldPath
.
- FieldPathPayloadSubsectionExtractor(String, String) - Constructor for class org.springframework.restdocs.payload.FieldPathPayloadSubsectionExtractor
-
Creates a new FieldPathPayloadSubsectionExtractor
that will extract the
subsection of the JSON payload beneath the given fieldPath
and that will
use the given subsectionId
to identify the subsection.
- FieldTypeRequiredException - Exception in org.springframework.restdocs.payload
-
A FieldTypeRequiredException
is thrown when a field's type cannot be determined
automatically and, therefore, must be explicitly provided.
- FieldTypeRequiredException(String) - Constructor for exception org.springframework.restdocs.payload.FieldTypeRequiredException
-
Creates a new FieldTypeRequiredException
indicating that a type is required
for the reason described in the given message
.
- FieldTypeResolver - Interface in org.springframework.restdocs.payload
-
Resolves the type of a field in a request or response payload.
- fieldWithPath(String) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Creates a FieldDescriptor
that describes a field with the given
path
.
- fileUpload(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
- fileUpload(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
- filter(FilterableRequestSpecification, FilterableResponseSpecification, FilterContext) - Method in class org.springframework.restdocs.restassured3.RestAssuredOperationPreprocessorsConfigurer
-
- filter(FilterableRequestSpecification, FilterableResponseSpecification, FilterContext) - Method in class org.springframework.restdocs.restassured3.RestAssuredRestDocumentationConfigurer
-
- filter(FilterableRequestSpecification, FilterableResponseSpecification, FilterContext) - Method in class org.springframework.restdocs.restassured3.RestAssuredSnippetConfigurer
-
- filter(FilterableRequestSpecification, FilterableResponseSpecification, FilterContext) - Method in class org.springframework.restdocs.restassured3.RestDocumentationFilter
-
- filter(ClientRequest, ExchangeFunction) - Method in class org.springframework.restdocs.webtestclient.WebTestClientOperationPreprocessorsConfigurer
-
- filter(ClientRequest, ExchangeFunction) - Method in class org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer
-
- filter(ClientRequest, ExchangeFunction) - Method in class org.springframework.restdocs.webtestclient.WebTestClientSnippetConfigurer
-
- findMissingHeaders(Operation) - Method in class org.springframework.restdocs.headers.AbstractHeadersSnippet
-
Finds the headers that are missing from the operation.
- forContent(byte[], MediaType) - Static method in interface org.springframework.restdocs.payload.FieldTypeResolver
-
- forContentWithDescriptors(byte[], MediaType, List<FieldDescriptor>) - Static method in interface org.springframework.restdocs.payload.FieldTypeResolver
-
Create a FieldTypeResolver
for the given content
and
contentType
, described by the given descriptors
.
- format(List<String>) - Method in interface org.springframework.restdocs.cli.CommandFormatter
-
Formats a list of elements
into a single String
.