Uses of Interface
org.springframework.restdocs.payload.PayloadSubsectionExtractor
Packages that use PayloadSubsectionExtractor
Package
Description
Documenting the payload of a RESTful API's requests and responses.
-
Uses of PayloadSubsectionExtractor in org.springframework.restdocs.payload
Classes in org.springframework.restdocs.payload with type parameters of type PayloadSubsectionExtractorModifier and TypeInterfaceDescriptioninterfacePayloadSubsectionExtractor<T extends PayloadSubsectionExtractor<T>>Strategy interface for extracting a subsection of a payload.Classes in org.springframework.restdocs.payload that implement PayloadSubsectionExtractorModifier and TypeClassDescriptionclassAPayloadSubsectionExtractorthat extracts the subsection of the JSON payload identified by a field path.Methods in org.springframework.restdocs.payload that return PayloadSubsectionExtractorModifier and TypeMethodDescriptionstatic PayloadSubsectionExtractor<?>PayloadDocumentation.beneathPath(String path) Returns aPayloadSubsectionExtractorthat will extract the subsection of the JSON payload found beneath the givenpath.protected final PayloadSubsectionExtractor<?>AbstractFieldsSnippet.getSubsectionExtractor()Returns thePayloadSubsectionExtractor, if any, used by this snippet.Methods in org.springframework.restdocs.payload with parameters of type PayloadSubsectionExtractorModifier and TypeMethodDescriptionstatic 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 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 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 RequestBodySnippetPayloadDocumentation.requestBody(PayloadSubsectionExtractor<?> subsectionExtractor) Returns aSnippetthat will document a subsection of the body of the API operation's request payload.static RequestBodySnippetPayloadDocumentation.requestBody(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes) Returns aSnippetthat will document a subsection of the body of the API operation'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.static RequestPartBodySnippetPayloadDocumentation.requestPartBody(String partName, PayloadSubsectionExtractor<?> subsectionExtractor) Returns aSnippetthat will document a subsection of the body of specified part of the API operation's request payload.static RequestPartBodySnippetPayloadDocumentation.requestPartBody(String partName, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes) Returns aSnippetthat will document a subsection of the body of specified part of the API operation'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.static ResponseBodySnippetPayloadDocumentation.responseBody(PayloadSubsectionExtractor<?> subsectionExtractor) Returns aSnippetthat will document a subsection of the body of the API operation's response payload.static ResponseBodySnippetPayloadDocumentation.responseBody(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes) Returns aSnippetthat will document a subsection of the body 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.Constructors in org.springframework.restdocs.payload with parameters of type PayloadSubsectionExtractorModifierConstructorDescriptionprotectedAbstractBodySnippet(String name, String type, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes) Creates a newAbstractBodySnippetthat will produce a snippet named<name>-bodyusing a template named<type>-body.protectedAbstractBodySnippet(String type, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes) Creates a newAbstractBodySnippetthat will produce a snippet named<type>-bodyusing a template named<type>-body.protectedAbstractFieldsSnippet(String name, String type, List<FieldDescriptor> descriptors, Map<String, Object> attributes, boolean ignoreUndocumentedFields, PayloadSubsectionExtractor<?> subsectionExtractor) Creates a newAbstractFieldsSnippetthat will produce a snippet named<name>-fieldsusing a template named<type>-fields.protectedAbstractFieldsSnippet(String type, List<FieldDescriptor> descriptors, Map<String, Object> attributes, boolean ignoreUndocumentedFields, PayloadSubsectionExtractor<?> subsectionExtractor) Creates a newAbstractFieldsSnippetthat will produce a snippet named<type>-fieldsusing a template named<type>-fields.RequestBodySnippet(PayloadSubsectionExtractor<?> subsectionExtractor) Creates a newRequestBodySnippetthat will document the subsection of the request body extracted by the givensubsectionExtractor.RequestBodySnippet(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes) Creates a newRequestBodySnippetthat will document the subsection of the request body extracted by the givensubsectionExtractor.protectedRequestFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors) Creates a newRequestFieldsSnippetthat will document the fields in the subsection of the request extracted by the givensubsectionExtractorusing the givendescriptors.protectedRequestFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, boolean ignoreUndocumentedFields) Creates a newRequestFieldsSnippetthat will document the fields in the subsection of the request extracted by the givensubsectionExtractorusing the givendescriptors.protectedRequestFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, Map<String, Object> attributes) Creates a newRequestFieldsSnippetthat will document the fields in the subsection of the request extracted by the givensubsectionExtractorusing the givendescriptors.protectedRequestFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, Map<String, Object> attributes, boolean ignoreUndocumentedFields) Creates a newRequestFieldsSnippetthat will document the fields in the subsection of the request extracted by the givensubsectionExtractorusing the givendescriptors.RequestPartBodySnippet(String partName, PayloadSubsectionExtractor<?> subsectionExtractor) Creates a newRequestPartBodySnippetthat will document the subsection of the body of the request part with the givenpartNameextracted by the givensubsectionExtractor.RequestPartBodySnippet(String partName, PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes) Creates a newRequestPartBodySnippetthat will document the body of the request part with the givenpartName.protectedRequestPartFieldsSnippet(String partName, PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors) Creates a newRequestPartFieldsSnippetthat will document the fields in a subsection of the request part using the givendescriptors.protectedRequestPartFieldsSnippet(String partName, PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, boolean ignoreUndocumentedFields) Creates a newRequestPartFieldsSnippetthat will document the fields in a subsection the request part using the givendescriptors.protectedRequestPartFieldsSnippet(String partName, PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, Map<String, Object> attributes) Creates a newRequestPartFieldsSnippetthat will document the fields in a subsection of the request part using the givendescriptors.protectedRequestPartFieldsSnippet(String partName, PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, Map<String, Object> attributes, boolean ignoreUndocumentedFields) Creates a newRequestPartFieldsSnippetthat will document the fields in a subsection of the request part using the givendescriptors.ResponseBodySnippet(PayloadSubsectionExtractor<?> subsectionExtractor) Creates a newResponseBodySnippetthat will document the subsection of the response body extracted by the givensubsectionExtractor.ResponseBodySnippet(PayloadSubsectionExtractor<?> subsectionExtractor, Map<String, Object> attributes) Creates a newResponseBodySnippetthat will document the subsection of the response body extracted by the givensubsectionExtractor.protectedResponseFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors) Creates a newResponseFieldsSnippetthat will document the fields in a subsection of the response using the givendescriptors.protectedResponseFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, boolean ignoreUndocumentedFields) Creates a newResponseFieldsSnippetthat will document the fields in the subsection of the response using the givendescriptors.protectedResponseFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, Map<String, Object> attributes) Creates a newResponseFieldsSnippetthat will document the fields in a subsection of the response using the givendescriptors.protectedResponseFieldsSnippet(PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, Map<String, Object> attributes, boolean ignoreUndocumentedFields) Creates a newResponseFieldsSnippetthat will document the fields in a subsection of the response using the givendescriptors.