Uses of Class
org.springframework.restdocs.payload.RequestFieldsSnippet
Packages that use RequestFieldsSnippet
Package
Description
Documenting the payload of a RESTful API's requests and responses.
-
Uses of RequestFieldsSnippet in org.springframework.restdocs.payload
Methods in org.springframework.restdocs.payload that return RequestFieldsSnippetModifier and TypeMethodDescriptionfinal RequestFieldsSnippetRequestFieldsSnippet.and(List<FieldDescriptor> additionalDescriptors) Returns a newRequestFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.final RequestFieldsSnippetRequestFieldsSnippet.and(FieldDescriptor... additionalDescriptors) Returns a newRequestFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.final RequestFieldsSnippetRequestFieldsSnippet.andWithPrefix(String pathPrefix, List<FieldDescriptor> additionalDescriptors) Returns a newRequestFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.final RequestFieldsSnippetRequestFieldsSnippet.andWithPrefix(String pathPrefix, FieldDescriptor... additionalDescriptors) Returns a newRequestFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.static RequestFieldsSnippetPayloadDocumentation.relaxedRequestFields(List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the API operations's request payload.static RequestFieldsSnippetPayloadDocumentation.relaxedRequestFields(Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the API operation's request payload.static RequestFieldsSnippetPayloadDocumentation.relaxedRequestFields(Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the API operation's request payload.static RequestFieldsSnippetPayloadDocumentation.relaxedRequestFields(FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the API operations's request payload.static RequestFieldsSnippetPayloadDocumentation.relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the subsection of the API operations's request payload extracted by the givensubsectionExtractor.static RequestFieldsSnippetPayloadDocumentation.relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the subsection of the API operation's request payload extracted by the givensubsectionExtractor.static RequestFieldsSnippetPayloadDocumentation.relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the subsection of the API operation's request payload extracted by the givensubsectionExtractor.static RequestFieldsSnippetPayloadDocumentation.relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the subsection of the API operations's request payload extracted by the givensubsectionExtractor.static RequestFieldsSnippetPayloadDocumentation.requestFields(List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the API operations's request payload.static RequestFieldsSnippetPayloadDocumentation.requestFields(Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the API operation's request payload.static RequestFieldsSnippetPayloadDocumentation.requestFields(Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the API operation's request payload.static RequestFieldsSnippetPayloadDocumentation.requestFields(FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the API operations's request payload.static RequestFieldsSnippetPayloadDocumentation.requestFields(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields in the subsection of the API operations's request payload extracted by the givensubsectionExtractor.static RequestFieldsSnippetPayloadDocumentation.requestFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the subsection of the API operation's request payload extracted by the givensubsectionExtractor.static RequestFieldsSnippetPayloadDocumentation.requestFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the subsection of the API operation's request payload extracted by the givensubsectionExtractor.static RequestFieldsSnippetPayloadDocumentation.requestFields(PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the subsection of API operations's request payload extracted by the givensubsectionExtractor.