Uses of Class
org.springframework.restdocs.payload.ResponseFieldsSnippet
Packages that use ResponseFieldsSnippet
Package
Description
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 ResponseFieldsSnippetModifier and TypeMethodDescriptionfinal ResponseFieldsSnippetResponseFieldsSnippet.and(List<FieldDescriptor> additionalDescriptors) Returns a newResponseFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.final ResponseFieldsSnippetResponseFieldsSnippet.and(FieldDescriptor... additionalDescriptors) Returns a newResponseFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.final ResponseFieldsSnippetResponseFieldsSnippet.andWithPrefix(String pathPrefix, List<FieldDescriptor> additionalDescriptors) Returns a newResponseFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.final ResponseFieldsSnippetResponseFieldsSnippet.andWithPrefix(String pathPrefix, FieldDescriptor... additionalDescriptors) Returns a newResponseFieldsSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.static ResponseFieldsSnippetPayloadDocumentation.relaxedResponseFields(List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.relaxedResponseFields(Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.relaxedResponseFields(Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.relaxedResponseFields(FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of a subsection of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of a subsection of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of a subsection of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.relaxedResponseFields(PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of a subsection of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.responseFields(List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.responseFields(Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.responseFields(Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.responseFields(FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of a subsection of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, List<FieldDescriptor> descriptors) Returns aSnippetthat will document the fields of a subsection of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of a subsection of the API operation's response payload.static ResponseFieldsSnippetPayloadDocumentation.responseFields(PayloadSubsectionExtractor<?> subsectionExtractor, FieldDescriptor... descriptors) Returns aSnippetthat will document the fields of a subsection of the API operation's response payload.