Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractBodySnippet - Class in org.springframework.restdocs.payload
-
Abstract
TemplatedSnippetsubclass that provides a base for snippets that document a RESTful resource's request or response body. - AbstractBodySnippet(String, String, PayloadSubsectionExtractor<?>, Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.AbstractBodySnippet
-
Creates a new
AbstractBodySnippetthat will produce a snippet named<name>-bodyusing a template named<type>-body. - AbstractBodySnippet(String, PayloadSubsectionExtractor<?>, Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.AbstractBodySnippet
-
Creates a new
AbstractBodySnippetthat will produce a snippet named<type>-bodyusing a template named<type>-body. - AbstractConfigurer - Class in org.springframework.restdocs.config
-
Abstract configurer that declares methods that are internal to the documentation configuration implementation.
- AbstractConfigurer() - Constructor for class org.springframework.restdocs.config.AbstractConfigurer
- AbstractCookiesSnippet - Class in org.springframework.restdocs.cookies
-
Abstract
TemplatedSnippetsubclass that provides a base for snippets that document a RESTful resource's request or response cookies. - AbstractCookiesSnippet(String, List<CookieDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.cookies.AbstractCookiesSnippet
-
Creates a new
AbstractCookiesSnippetthat will produce a snippet named<type>-cookies. - AbstractDescriptor<T extends AbstractDescriptor<T>> - Class in org.springframework.restdocs.snippet
-
Base class for descriptors.
- AbstractDescriptor() - Constructor for class org.springframework.restdocs.snippet.AbstractDescriptor
- AbstractFieldsSnippet - Class in org.springframework.restdocs.payload
-
Abstract
TemplatedSnippetsubclass that provides a base for snippets that document a RESTful resource's request or response fields. - AbstractFieldsSnippet(String, String, List<FieldDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.payload.AbstractFieldsSnippet
-
Creates a new
AbstractFieldsSnippetthat will produce a snippet named<name>-fieldsusing a template named<type>-fields. - AbstractFieldsSnippet(String, String, List<FieldDescriptor>, Map<String, Object>, boolean, PayloadSubsectionExtractor<?>) - Constructor for class org.springframework.restdocs.payload.AbstractFieldsSnippet
-
Creates a new
AbstractFieldsSnippetthat will produce a snippet named<name>-fieldsusing a template named<type>-fields. - AbstractFieldsSnippet(String, List<FieldDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.payload.AbstractFieldsSnippet
-
Creates a new
AbstractFieldsSnippetthat will produce a snippet named<type>-fieldsusing a template named<type>-fields. - AbstractFieldsSnippet(String, List<FieldDescriptor>, Map<String, Object>, boolean, PayloadSubsectionExtractor<?>) - Constructor for class org.springframework.restdocs.payload.AbstractFieldsSnippet
-
Creates a new
AbstractFieldsSnippetthat will produce a snippet named<type>-fieldsusing a template named<type>-fields. - AbstractHeadersSnippet - Class in org.springframework.restdocs.headers
-
Abstract
TemplatedSnippetsubclass that provides a base for snippets that document a RESTful resource's request or response headers. - AbstractHeadersSnippet(String, List<HeaderDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.headers.AbstractHeadersSnippet
-
Creates a new
AbstractHeadersSnippetthat will produce a snippet named<type>-headers. - AbstractNestedConfigurer<PARENT> - Class in org.springframework.restdocs.config
-
Base class for
NestedConfigurerimplementations. - AbstractNestedConfigurer(PARENT) - Constructor for class org.springframework.restdocs.config.AbstractNestedConfigurer
-
Creates a new
AbstractNestedConfigurerwith the givenparent. - AbstractParametersSnippet - Class in org.springframework.restdocs.request
-
Abstract
TemplatedSnippetsubclass that provides a base for snippets that document parameters from a request sent to a RESTful resource. - AbstractParametersSnippet(String, List<ParameterDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.request.AbstractParametersSnippet
-
Creates a new
AbstractParametersSnippetthat will produce a snippet with the givensnippetNamethat will document parameters using the givendescriptors. - add(String, String) - Method in class org.springframework.restdocs.operation.preprocess.HeadersModifyingOperationPreprocessor
-
Adds a header with the given
nameandvalue. - add(String, String) - Method in class org.springframework.restdocs.operation.preprocess.ParametersModifyingOperationPreprocessor
-
Adds a parameter with the given
nameandvalue. - afterConfigurerAdded(ConfigurableMockMvcBuilder<?>) - Method in class org.springframework.restdocs.mockmvc.MockMvcOperationPreprocessorsConfigurer
- afterConfigurerAdded(ConfigurableMockMvcBuilder<?>) - Method in class org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer
- afterConfigurerAdded(ConfigurableMockMvcBuilder<?>) - Method in class org.springframework.restdocs.mockmvc.MockMvcSnippetConfigurer
- afterConfigurerAdded(ConfigurableMockMvcBuilder<?>) - Method in class org.springframework.restdocs.mockmvc.UriConfigurer
- afterEach(ExtensionContext) - Method in class org.springframework.restdocs.RestDocumentationExtension
- afterTest() - Method in class org.springframework.restdocs.ManualRestDocumentation
-
Notification that a test has completed.
- and() - Method in class org.springframework.restdocs.config.AbstractNestedConfigurer
- and(List<CookieDescriptor>) - Method in class org.springframework.restdocs.cookies.RequestCookiesSnippet
-
Returns a new
RequestCookiesSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(List<CookieDescriptor>) - Method in class org.springframework.restdocs.cookies.ResponseCookiesSnippet
-
Returns a new
ResponseCookiesSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(List<HeaderDescriptor>) - Method in class org.springframework.restdocs.headers.RequestHeadersSnippet
-
Returns a new
RequestHeadersSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(List<HeaderDescriptor>) - Method in class org.springframework.restdocs.headers.ResponseHeadersSnippet
-
Returns a new
ResponseHeadersSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(List<LinkDescriptor>) - Method in class org.springframework.restdocs.hypermedia.LinksSnippet
-
Returns a new
LinksSnippetconfigured with this snippet's link extractor and attributes, and its descriptors combined with the givenadditionalDescriptors. - and(List<FieldDescriptor>) - Method in class org.springframework.restdocs.payload.RequestFieldsSnippet
-
Returns a new
RequestFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(List<FieldDescriptor>) - Method in class org.springframework.restdocs.payload.RequestPartFieldsSnippet
-
Returns a new
RequestPartFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(List<FieldDescriptor>) - Method in class org.springframework.restdocs.payload.ResponseFieldsSnippet
-
Returns a new
ResponseFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(List<ParameterDescriptor>) - Method in class org.springframework.restdocs.request.PathParametersSnippet
-
Returns a new
PathParametersSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(List<ParameterDescriptor>) - Method in class org.springframework.restdocs.request.RequestParametersSnippet
-
Returns a new
RequestParametersSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(List<RequestPartDescriptor>) - Method in class org.springframework.restdocs.request.RequestPartsSnippet
-
Returns a new
RequestPartsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(CookieDescriptor...) - Method in class org.springframework.restdocs.cookies.RequestCookiesSnippet
-
Returns a new
RequestCookiesSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(CookieDescriptor...) - Method in class org.springframework.restdocs.cookies.ResponseCookiesSnippet
-
Returns a new
ResponseCookiesSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(HeaderDescriptor...) - Method in class org.springframework.restdocs.headers.RequestHeadersSnippet
-
Returns a new
RequestHeadersSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(HeaderDescriptor...) - Method in class org.springframework.restdocs.headers.ResponseHeadersSnippet
-
Returns a new
ResponseHeadersSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(LinkDescriptor...) - Method in class org.springframework.restdocs.hypermedia.LinksSnippet
-
Returns a new
LinksSnippetconfigured with this snippet's link extractor and attributes, and its descriptors combined with the givenadditionalDescriptors. - and(FieldDescriptor...) - Method in class org.springframework.restdocs.payload.RequestFieldsSnippet
-
Returns a new
RequestFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(FieldDescriptor...) - Method in class org.springframework.restdocs.payload.RequestPartFieldsSnippet
-
Returns a new
RequestPartFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(FieldDescriptor...) - Method in class org.springframework.restdocs.payload.ResponseFieldsSnippet
-
Returns a new
ResponseFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(ParameterDescriptor...) - Method in class org.springframework.restdocs.request.PathParametersSnippet
-
Returns a new
PathParametersSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(ParameterDescriptor...) - Method in class org.springframework.restdocs.request.RequestParametersSnippet
-
Returns a new
RequestParametersSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - and(RequestPartDescriptor...) - Method in class org.springframework.restdocs.request.RequestPartsSnippet
-
Returns a new
RequestPartsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - andWithPrefix(String, List<FieldDescriptor>) - Method in class org.springframework.restdocs.payload.RequestFieldsSnippet
-
Returns a new
RequestFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - andWithPrefix(String, List<FieldDescriptor>) - Method in class org.springframework.restdocs.payload.RequestPartFieldsSnippet
-
Returns a new
RequestFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - andWithPrefix(String, List<FieldDescriptor>) - Method in class org.springframework.restdocs.payload.ResponseFieldsSnippet
-
Returns a new
ResponseFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - andWithPrefix(String, FieldDescriptor...) - Method in class org.springframework.restdocs.payload.RequestFieldsSnippet
-
Returns a new
RequestFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - andWithPrefix(String, FieldDescriptor...) - Method in class org.springframework.restdocs.payload.RequestPartFieldsSnippet
-
Returns a new
RequestFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - andWithPrefix(String, FieldDescriptor...) - Method in class org.springframework.restdocs.payload.ResponseFieldsSnippet
-
Returns a new
ResponseFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors. - apply(Map<String, Object>, RestDocumentationContext) - Method in class org.springframework.restdocs.config.AbstractConfigurer
-
Applies the configurer to the given
configuration. - apply(Map<String, Object>, RestDocumentationContext) - Method in class org.springframework.restdocs.config.OperationPreprocessorsConfigurer
- apply(Map<String, Object>, RestDocumentationContext) - Method in class org.springframework.restdocs.config.RestDocumentationConfigurer
-
Applies this configurer to the given
configurationwithin the givencontext. - apply(Map<String, Object>, RestDocumentationContext) - Method in class org.springframework.restdocs.config.SnippetConfigurer
- apply(Map<String, Object>, RestDocumentationContext) - Method in class org.springframework.restdocs.mockmvc.UriConfigurer
- apply(Statement, Description) - Method in class org.springframework.restdocs.JUnitRestDocumentation
- applyPathPrefix(String, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Creates a copy of the given
descriptorswith the givenpathPrefixapplied to their paths. - ARRAY - Enum constant in enum class org.springframework.restdocs.payload.JsonFieldType
-
An array.
- asciidoctor() - Static method in class org.springframework.restdocs.templates.TemplateFormats
-
Returns the Asciidoctor template format with the ID
asciidoctorand the file extensionadoc. - AsciidoctorTableCellContentLambda - Class in org.springframework.restdocs.templates.mustache
-
A
Mustache.Lambdathat escapes|characters so that the do not break the table's formatting. - AsciidoctorTableCellContentLambda() - Constructor for class org.springframework.restdocs.templates.mustache.AsciidoctorTableCellContentLambda
- atomLinks() - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation
-
Returns a
LinkExtractorcapable of extracting links in Atom format where the links are found in an array namedlinks. - Attribute(String, Object) - Constructor for class org.springframework.restdocs.snippet.Attributes.Attribute
-
Creates a new attribute with the given
keyandvalue. - ATTRIBUTE_NAME_DEFAULT_OPERATION_REQUEST_PREPROCESSOR - Static variable in class org.springframework.restdocs.generate.RestDocumentationGenerator
-
Name of the operation attribute used to hold the default operation request preprocessor.
- ATTRIBUTE_NAME_DEFAULT_OPERATION_RESPONSE_PREPROCESSOR - Static variable in class org.springframework.restdocs.generate.RestDocumentationGenerator
-
Name of the operation attribute used to hold the default operation response preprocessor.
- ATTRIBUTE_NAME_DEFAULT_SNIPPETS - Static variable in class org.springframework.restdocs.generate.RestDocumentationGenerator
-
Name of the operation attribute used to hold the
Listof default snippets. - ATTRIBUTE_NAME_URL_TEMPLATE - Static variable in class org.springframework.restdocs.generate.RestDocumentationGenerator
-
Name of the operation attribute used to hold the request's URL template.
- attributes(Attributes.Attribute...) - Method in class org.springframework.restdocs.snippet.AbstractDescriptor
-
Adds the given
attributesto the descriptor. - attributes(Attributes.Attribute...) - Static method in class org.springframework.restdocs.snippet.Attributes
-
Creates a
Mapof the givenattributes. - Attributes - Class in org.springframework.restdocs.snippet
-
A fluent API for building a map of attributes.
- Attributes.Attribute - Class in org.springframework.restdocs.snippet
-
An attribute (key-value pair).
- Attributes.AttributeBuilder - Class in org.springframework.restdocs.snippet
-
A simple builder for an attribute (key-value pair).
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form