Uses of Class
org.springframework.restdocs.payload.ResponseFieldsSnippet

Packages that use ResponseFieldsSnippet

Package	Description
org.springframework.restdocs.payload	Documenting the payload of a RESTful API's requests and responses.

Uses of ResponseFieldsSnippet in org.springframework.restdocs.payload

Methods in org.springframework.restdocs.payload that return ResponseFieldsSnippet

Modifier and Type	Method and Description
ResponseFieldsSnippet	ResponseFieldsSnippet.and(FieldDescriptor... additionalDescriptors) Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
ResponseFieldsSnippet	ResponseFieldsSnippet.and(java.util.List<FieldDescriptor> additionalDescriptors) Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
ResponseFieldsSnippet	ResponseFieldsSnippet.andWithPrefix(java.lang.String pathPrefix, FieldDescriptor... additionalDescriptors) Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
ResponseFieldsSnippet	ResponseFieldsSnippet.andWithPrefix(java.lang.String pathPrefix, java.util.List<FieldDescriptor> additionalDescriptors) Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(FieldDescriptor... descriptors) Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(java.util.List<FieldDescriptor> descriptors) Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(java.util.Map<java.lang.String,java.lang.Object> attributes, FieldDescriptor... descriptors) Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.List<FieldDescriptor> descriptors) Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors) Returns a Snippet that will document the fields of a subsection of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, java.util.List<FieldDescriptor> descriptors) Returns a Snippet that will document the fields of a subsection of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, java.util.Map<java.lang.String,java.lang.Object> attributes, FieldDescriptor... descriptors) Returns a Snippet that will document the fields of a subsection of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.List<FieldDescriptor> descriptors) Returns a Snippet that will document the fields of a subsection of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(FieldDescriptor... descriptors) Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(java.util.List<FieldDescriptor> descriptors) Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(java.util.Map<java.lang.String,java.lang.Object> attributes, FieldDescriptor... descriptors) Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.List<FieldDescriptor> descriptors) Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors) Returns a Snippet that will document the fields of a subsection of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, java.util.List<FieldDescriptor> descriptors) Returns a Snippet that will document the fields of a subsection of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, java.util.Map<java.lang.String,java.lang.Object> attributes, FieldDescriptor... descriptors) Returns a Snippet that will document the fields of a subsection of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, java.util.Map<java.lang.String,java.lang.Object> attributes, java.util.List<FieldDescriptor> descriptors) Returns a Snippet that will document the fields of a subsection of the API operation's response payload.