Class RequestFieldsSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

org.springframework.restdocs.payload.AbstractFieldsSnippet

org.springframework.restdocs.payload.RequestFieldsSnippet

All Implemented Interfaces:

Snippet

public class RequestFieldsSnippet
extends AbstractFieldsSnippet

A Snippet that documents the fields in a request.

Author:

Andy Wilkinson

See Also:

• PayloadDocumentation.requestFields(FieldDescriptor...)
• PayloadDocumentation.requestFields(Map, FieldDescriptor...)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RequestFieldsSnippet(List<FieldDescriptor> descriptors)	Creates a new RequestFieldsSnippet that will document the fields in the request using the given descriptors.
protected	RequestFieldsSnippet(List<FieldDescriptor> descriptors, boolean ignoreUndocumentedFields)	Creates a new RequestFieldsSnippet that will document the fields in the request using the given descriptors.
protected	RequestFieldsSnippet(List<FieldDescriptor> descriptors, @Nullable Map<String,Object> attributes)	Creates a new RequestFieldsSnippet that will document the fields in the request using the given descriptors.
protected	RequestFieldsSnippet(List<FieldDescriptor> descriptors, @Nullable Map<String,Object> attributes, boolean ignoreUndocumentedFields)	Creates a new RequestFieldsSnippet that will document the fields in the request using the given descriptors.
protected	RequestFieldsSnippet(@Nullable PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors)	Creates a new RequestFieldsSnippet that will document the fields in the subsection of the request extracted by the given subsectionExtractor using the given descriptors.
protected	RequestFieldsSnippet(@Nullable PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, boolean ignoreUndocumentedFields)	Creates a new RequestFieldsSnippet that will document the fields in the subsection of the request extracted by the given subsectionExtractor using the given descriptors.
protected	RequestFieldsSnippet(@Nullable PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, @Nullable Map<String,Object> attributes)	Creates a new RequestFieldsSnippet that will document the fields in the subsection of the request extracted by the given subsectionExtractor using the given descriptors.
protected	RequestFieldsSnippet(@Nullable PayloadSubsectionExtractor<?> subsectionExtractor, List<FieldDescriptor> descriptors, @Nullable Map<String,Object> attributes, boolean ignoreUndocumentedFields)	Creates a new RequestFieldsSnippet that will document the fields in the subsection of the request extracted by the given subsectionExtractor using the given descriptors.

Method Summary

Modifier and Type	Method	Description
final RequestFieldsSnippet	and(List<FieldDescriptor> additionalDescriptors)	Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final RequestFieldsSnippet	and(FieldDescriptor... additionalDescriptors)	Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final RequestFieldsSnippet	andWithPrefix(String pathPrefix, List<FieldDescriptor> additionalDescriptors)	Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
final RequestFieldsSnippet	andWithPrefix(String pathPrefix, FieldDescriptor... additionalDescriptors)	Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.
protected byte[]	getContent(Operation operation)	Returns the content of the request or response extracted form the given operation.
protected @Nullable org.springframework.http.MediaType	getContentType(Operation operation)	Returns the content type of the request or response extracted from the given operation.

Methods inherited from class AbstractFieldsSnippet

createModel, createModelForDescriptor, getFieldDescriptors, getSubsectionExtractor, isIgnoredUndocumentedFields

Methods inherited from class TemplatedSnippet

document, getAttributes, getSnippetName

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RequestFieldsSnippet

protected RequestFieldsSnippet(List<FieldDescriptor> descriptors)

Creates a new RequestFieldsSnippet that will document the fields in the request using the given descriptors. Undocumented fields will trigger a failure.

Parameters:

descriptors - the descriptors

RequestFieldsSnippet

protected RequestFieldsSnippet(List<FieldDescriptor> descriptors,
 boolean ignoreUndocumentedFields)

Creates a new RequestFieldsSnippet that will document the fields in the request using the given descriptors. If ignoreUndocumentedFields is true, undocumented fields will be ignored and will not trigger a failure.

Parameters:

descriptors - the descriptors

ignoreUndocumentedFields - whether undocumented fields should be ignored

RequestFieldsSnippet

protected RequestFieldsSnippet(List<FieldDescriptor> descriptors,
 @Nullable Map<String,Object> attributes)

Creates a new RequestFieldsSnippet that will document the fields in the request using the given descriptors. The given attributes will be included in the model during template rendering. Undocumented fields will trigger a failure.

Parameters:

descriptors - the descriptors

attributes - the additional attributes

RequestFieldsSnippet

protected RequestFieldsSnippet(List<FieldDescriptor> descriptors,
 @Nullable Map<String,Object> attributes,
 boolean ignoreUndocumentedFields)

Creates a new RequestFieldsSnippet that will document the fields in the request using the given descriptors. The given attributes will be included in the model during template rendering. If ignoreUndocumentedFields is true, undocumented fields will be ignored and will not trigger a failure.

Parameters:

descriptors - the descriptors

attributes - the additional attributes

ignoreUndocumentedFields - whether undocumented fields should be ignored

RequestFieldsSnippet

protected RequestFieldsSnippet(@Nullable PayloadSubsectionExtractor<?> subsectionExtractor,
 List<FieldDescriptor> descriptors)

Creates a new RequestFieldsSnippet that will document the fields in the subsection of the request extracted by the given subsectionExtractor using the given descriptors. Undocumented fields will trigger a failure.

Parameters:

subsectionExtractor - the subsection extractor

descriptors - the descriptors

Since:

1.2.0

RequestFieldsSnippet

protected RequestFieldsSnippet(@Nullable PayloadSubsectionExtractor<?> subsectionExtractor,
 List<FieldDescriptor> descriptors,
 boolean ignoreUndocumentedFields)

Creates a new RequestFieldsSnippet that will document the fields in the subsection of the request extracted by the given subsectionExtractor using the given descriptors. If the extractor is null, the fields of the entire request will be documented. If ignoreUndocumentedFields is true, undocumented fields will be ignored and will not trigger a failure.

Parameters:

subsectionExtractor - the subsection extractor or null to document the fields of the entire request

descriptors - the descriptors

ignoreUndocumentedFields - whether undocumented fields should be ignored

Since:

1.2.0

RequestFieldsSnippet

protected RequestFieldsSnippet(@Nullable PayloadSubsectionExtractor<?> subsectionExtractor,
 List<FieldDescriptor> descriptors,
 @Nullable Map<String,Object> attributes)

Creates a new RequestFieldsSnippet that will document the fields in the subsection of the request extracted by the given subsectionExtractor using the given descriptors. If the extractor is null, the fields of the entire request will be documented. The given attributes will be included in the model during template rendering. Undocumented fields will trigger a failure.

Parameters:

subsectionExtractor - the subsection extractor or null to document the fields of the entire request

descriptors - the descriptors

attributes - the additional attributes

Since:

1.2.0

RequestFieldsSnippet

protected RequestFieldsSnippet(@Nullable PayloadSubsectionExtractor<?> subsectionExtractor,
 List<FieldDescriptor> descriptors,
 @Nullable Map<String,Object> attributes,
 boolean ignoreUndocumentedFields)

Creates a new RequestFieldsSnippet that will document the fields in the subsection of the request extracted by the given subsectionExtractor using the given descriptors. If the extractor is null, the fields of the entire request will be documented. The given attributes will be included in the model during template rendering. If ignoreUndocumentedFields is true, undocumented fields will be ignored and will not trigger a failure.

Parameters:

subsectionExtractor - the subsection extractor or null to document the fields of the entire request

descriptors - the descriptors

attributes - the additional attributes

ignoreUndocumentedFields - whether undocumented fields should be ignored

Since:

1.2.0

Method Details

getContentType

protected @Nullable org.springframework.http.MediaType getContentType(Operation operation)

Description copied from class: AbstractFieldsSnippet

Returns the content type of the request or response extracted from the given operation.

Specified by:

getContentType in class AbstractFieldsSnippet

Parameters:

operation - the operation

Returns:

the content type

getContent

protected byte[] getContent(Operation operation)
                     throws IOException

Description copied from class: AbstractFieldsSnippet

Returns the content of the request or response extracted form the given operation.

Specified by:

getContent in class AbstractFieldsSnippet

Parameters:

operation - the operation

Returns:

the content

Throws:

IOException - if the content cannot be extracted

and

public final RequestFieldsSnippet and(FieldDescriptor... additionalDescriptors)

Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

Parameters:

additionalDescriptors - the additional descriptors

Returns:

the new snippet

and

public final RequestFieldsSnippet and(List<FieldDescriptor> additionalDescriptors)

Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

Parameters:

additionalDescriptors - the additional descriptors

Returns:

the new snippet

andWithPrefix

public final RequestFieldsSnippet andWithPrefix(String pathPrefix,
 FieldDescriptor... additionalDescriptors)

Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors. The given pathPrefix is applied to the path of each additional descriptor.

Parameters:

pathPrefix - the prefix to apply to the additional descriptors

additionalDescriptors - the additional descriptors

Returns:

the new snippet

andWithPrefix

public final RequestFieldsSnippet andWithPrefix(String pathPrefix,
 List<FieldDescriptor> additionalDescriptors)

Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors. The given pathPrefix is applied to the path of each additional descriptor.

Parameters:

pathPrefix - the prefix to apply to the additional descriptors

additionalDescriptors - the additional descriptors

Returns:

the new snippet