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	Description
final ResponseFieldsSnippet	ResponseFieldsSnippet.and(List<FieldDescriptor> additionalDescriptors)	Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final ResponseFieldsSnippet	ResponseFieldsSnippet.and(FieldDescriptor... additionalDescriptors)	Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final ResponseFieldsSnippet	ResponseFieldsSnippet.andWithPrefix(String pathPrefix, List<FieldDescriptor> additionalDescriptors)	Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final ResponseFieldsSnippet	ResponseFieldsSnippet.andWithPrefix(String pathPrefix, FieldDescriptor... additionalDescriptors)	Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(Map<String,Object> attributes, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.relaxedResponseFields(Map<String,Object> attributes, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of the API operation's response payload.
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(PayloadSubsectionExtractor<?> subsectionExtractor, 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, Map<String,Object> attributes, 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, Map<String,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, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of a subsection of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(Map<String,Object> attributes, List<FieldDescriptor> descriptors)	Returns a Snippet that will document the fields of the API operation's response payload.
static ResponseFieldsSnippet	PayloadDocumentation.responseFields(Map<String,Object> attributes, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields 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(PayloadSubsectionExtractor<?> subsectionExtractor, 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, Map<String,Object> attributes, 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, Map<String,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, FieldDescriptor... descriptors)	Returns a Snippet that will document the fields of a subsection of the API operation's response payload.