Uses of Class
org.springframework.restdocs.payload.RequestPartFieldsSnippet
Packages that use RequestPartFieldsSnippet
Package
Description
Documenting the payload of a RESTful API's requests and responses.
-
Uses of RequestPartFieldsSnippet in org.springframework.restdocs.payload
Methods in org.springframework.restdocs.payload that return RequestPartFieldsSnippetModifier and TypeMethodDescriptionfinal RequestPartFieldsSnippetRequestPartFieldsSnippet.and(List<FieldDescriptor> additionalDescriptors) Returns a newRequestPartFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.final RequestPartFieldsSnippetRequestPartFieldsSnippet.and(FieldDescriptor... additionalDescriptors) Returns a newRequestPartFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.final RequestPartFieldsSnippetRequestPartFieldsSnippet.andWithPrefix(String pathPrefix, List<FieldDescriptor> additionalDescriptors) Returns a newRequestFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.final RequestPartFieldsSnippetRequestPartFieldsSnippet.andWithPrefix(String pathPrefix, FieldDescriptor... additionalDescriptors) Returns a newRequestFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.static RequestPartFieldsSnippetPayloadDocumentation.relaxedRequestPartFields(String part, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.relaxedRequestPartFields(String part, Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.relaxedRequestPartFields(String part, Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.relaxedRequestPartFields(String part, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.relaxedRequestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of a subsection of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.relaxedRequestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of a subsection of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.relaxedRequestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of a subsection of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.relaxedRequestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of a subsection of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.requestPartFields(String part, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.requestPartFields(String part, Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.requestPartFields(String part, Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.requestPartFields(String part, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.requestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of a subsection of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.requestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of a subsection of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.requestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of a subsection of the specifiedpartof the API operations's request payload.static RequestPartFieldsSnippetPayloadDocumentation.requestPartFields(String part, PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of a subsection of the specifiedpartof the API operations's request payload.