Package | Description |
---|---|
org.springframework.restdocs.payload |
Documenting the payload of a RESTful API's requests and responses.
|
Modifier and Type | Method and Description |
---|---|
RequestFieldsSnippet |
RequestFieldsSnippet.and(FieldDescriptor... additionalDescriptors)
Returns a new
RequestFieldsSnippet configured with this snippet's
attributes and its descriptors combined with the given
additionalDescriptors . |
RequestFieldsSnippet |
RequestFieldsSnippet.and(java.util.List<FieldDescriptor> additionalDescriptors)
Returns a new
RequestFieldsSnippet configured with this snippet's
attributes and its descriptors combined with the given
additionalDescriptors . |
RequestFieldsSnippet |
RequestFieldsSnippet.andWithPrefix(java.lang.String pathPrefix,
FieldDescriptor... additionalDescriptors)
Returns a new
RequestFieldsSnippet configured with this snippet's
attributes and its descriptors combined with the given
additionalDescriptors . |
RequestFieldsSnippet |
RequestFieldsSnippet.andWithPrefix(java.lang.String pathPrefix,
java.util.List<FieldDescriptor> additionalDescriptors)
Returns a new
RequestFieldsSnippet configured with this snippet's
attributes and its descriptors combined with the given
additionalDescriptors . |
static RequestFieldsSnippet |
PayloadDocumentation.relaxedRequestFields(FieldDescriptor... descriptors)
Returns a
Snippet that will document the fields of the API operations's
request payload. |
static RequestFieldsSnippet |
PayloadDocumentation.relaxedRequestFields(java.util.List<FieldDescriptor> descriptors)
Returns a
Snippet that will document the fields of the API operations's
request payload. |
static RequestFieldsSnippet |
PayloadDocumentation.relaxedRequestFields(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
request payload. |
static RequestFieldsSnippet |
PayloadDocumentation.relaxedRequestFields(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
request payload. |
static RequestFieldsSnippet |
PayloadDocumentation.relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor,
FieldDescriptor... descriptors)
Returns a
Snippet that will document the fields of the subsection of the
API operations's request payload extracted by the given subsectionExtractor
. |
static RequestFieldsSnippet |
PayloadDocumentation.relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor,
java.util.List<FieldDescriptor> descriptors)
Returns a
Snippet that will document the fields of the subsection of the
API operations's request payload extracted by the given subsectionExtractor
. |
static RequestFieldsSnippet |
PayloadDocumentation.relaxedRequestFields(PayloadSubsectionExtractor<?> subsectionExtractor,
java.util.Map<java.lang.String,java.lang.Object> attributes,
FieldDescriptor... descriptors)
Returns a
Snippet that will document the fields of the subsection of the
API operation's request payload extracted by the given subsectionExtractor . |
static RequestFieldsSnippet |
PayloadDocumentation.relaxedRequestFields(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 the subsection of the
API operation's request payload extracted by the given subsectionExtractor . |
static RequestFieldsSnippet |
PayloadDocumentation.requestFields(FieldDescriptor... descriptors)
Returns a
Snippet that will document the fields of the API operations's
request payload. |
static RequestFieldsSnippet |
PayloadDocumentation.requestFields(java.util.List<FieldDescriptor> descriptors)
Returns a
Snippet that will document the fields of the API operations's
request payload. |
static RequestFieldsSnippet |
PayloadDocumentation.requestFields(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
request payload. |
static RequestFieldsSnippet |
PayloadDocumentation.requestFields(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
request payload. |
static RequestFieldsSnippet |
PayloadDocumentation.requestFields(PayloadSubsectionExtractor<?> subsectionExtractor,
FieldDescriptor... descriptors)
Returns a
Snippet that will document the fields of the subsection of API
operations's request payload extracted by the given subsectionExtractor . |
static RequestFieldsSnippet |
PayloadDocumentation.requestFields(PayloadSubsectionExtractor<?> subsectionExtractor,
java.util.List<FieldDescriptor> descriptors)
Returns a
Snippet that will document the fields in the subsection of the
API operations's request payload extracted by the given subsectionExtractor
. |
static RequestFieldsSnippet |
PayloadDocumentation.requestFields(PayloadSubsectionExtractor<?> subsectionExtractor,
java.util.Map<java.lang.String,java.lang.Object> attributes,
FieldDescriptor... descriptors)
Returns a
Snippet that will document the fields of the subsection of the
API operation's request payload extracted by the given subsectionExtractor . |
static RequestFieldsSnippet |
PayloadDocumentation.requestFields(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 the subsection of the
API operation's request payload extracted by the given subsectionExtractor . |