Uses of Class
org.springframework.restdocs.payload.RequestPartFieldsSnippet
Package
Description
Documenting the payload of a RESTful API's requests and responses.
-
Uses of RequestPartFieldsSnippet in org.springframework.restdocs.payload
Modifier and TypeMethodDescriptionfinal RequestPartFieldsSnippet
RequestPartFieldsSnippet.and
(List<FieldDescriptor> additionalDescriptors) Returns a newRequestPartFieldsSnippet
configured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors
.final RequestPartFieldsSnippet
RequestPartFieldsSnippet.and
(FieldDescriptor... additionalDescriptors) Returns a newRequestPartFieldsSnippet
configured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors
.final RequestPartFieldsSnippet
RequestPartFieldsSnippet.andWithPrefix
(String pathPrefix, List<FieldDescriptor> additionalDescriptors) Returns a newRequestFieldsSnippet
configured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors
.final RequestPartFieldsSnippet
RequestPartFieldsSnippet.andWithPrefix
(String pathPrefix, FieldDescriptor... additionalDescriptors) Returns a newRequestFieldsSnippet
configured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors
.static RequestPartFieldsSnippet
PayloadDocumentation.relaxedRequestPartFields
(String part, List<FieldDescriptor> descriptors) Returns aSnippet
that will document the fields of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.relaxedRequestPartFields
(String part, Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippet
that will document the fields of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.relaxedRequestPartFields
(String part, Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippet
that will document the fields of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.relaxedRequestPartFields
(String part, FieldDescriptor... descriptors) Returns aSnippet
that will document the fields of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.relaxedRequestPartFields
(String part, PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors) Returns aSnippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.relaxedRequestPartFields
(String part, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.relaxedRequestPartFields
(String part, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.relaxedRequestPartFields
(String part, PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors) Returns aSnippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.requestPartFields
(String part, List<FieldDescriptor> descriptors) Returns aSnippet
that will document the fields of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.requestPartFields
(String part, Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippet
that will document the fields of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.requestPartFields
(String part, Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippet
that will document the fields of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.requestPartFields
(String part, FieldDescriptor... descriptors) Returns aSnippet
that will document the fields of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.requestPartFields
(String part, PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors) Returns aSnippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.requestPartFields
(String part, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.requestPartFields
(String part, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload.static RequestPartFieldsSnippet
PayloadDocumentation.requestPartFields
(String part, PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors) Returns aSnippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload.