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