org.springframework.restdocs.payload

Class AbstractFieldsSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

org.springframework.restdocs.payload.AbstractFieldsSnippet

All Implemented Interfaces:

Snippet

Direct Known Subclasses:

RequestFieldsSnippet, RequestPartFieldsSnippet, ResponseFieldsSnippet

public abstract class AbstractFieldsSnippet
extends TemplatedSnippet

Abstract TemplatedSnippet subclass that provides a base for snippets that document a RESTful resource's request or response fields.

Author:

Andreas Evers, Andy Wilkinson, Mathias Düsterhöft

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFieldsSnippet(java.lang.String type, java.util.List<FieldDescriptor> descriptors, java.util.Map<java.lang.String,java.lang.Object> attributes, boolean ignoreUndocumentedFields) Creates a new AbstractFieldsSnippet that will produce a snippet named <type>-fields using a template named <type>-fields.
protected	AbstractFieldsSnippet(java.lang.String type, java.util.List<FieldDescriptor> descriptors, java.util.Map<java.lang.String,java.lang.Object> attributes, boolean ignoreUndocumentedFields, PayloadSubsectionExtractor<?> subsectionExtractor) Creates a new AbstractFieldsSnippet that will produce a snippet named <type>-fields using a template named <type>-fields.
protected	AbstractFieldsSnippet(java.lang.String name, java.lang.String type, java.util.List<FieldDescriptor> descriptors, java.util.Map<java.lang.String,java.lang.Object> attributes, boolean ignoreUndocumentedFields) Creates a new AbstractFieldsSnippet that will produce a snippet named <name>-fields using a template named <type>-fields.
protected	AbstractFieldsSnippet(java.lang.String name, java.lang.String type, java.util.List<FieldDescriptor> descriptors, java.util.Map<java.lang.String,java.lang.Object> attributes, boolean ignoreUndocumentedFields, PayloadSubsectionExtractor<?> subsectionExtractor) Creates a new AbstractFieldsSnippet that will produce a snippet named <name>-fields using a template named <type>-fields.

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	createModel(Operation operation) Create the model that should be used during template rendering to document the given operation.
protected java.util.Map<java.lang.String,java.lang.Object>	createModelForDescriptor(FieldDescriptor descriptor) Returns a model for the given descriptor.
protected abstract byte[]	getContent(Operation operation) Returns the content of the request or response extracted form the given operation.
protected abstract org.springframework.http.MediaType	getContentType(Operation operation) Returns the content type of the request or response extracted from the given operation.
protected java.util.List<FieldDescriptor>	getFieldDescriptors() Returns the list of FieldDescriptors that will be used to generate the documentation.
protected PayloadSubsectionExtractor<?>	getSubsectionExtractor() Returns the PayloadSubsectionExtractor, if any, used by this snippet.
protected boolean	isIgnoredUndocumentedFields() Returns whether or not this snippet ignores undocumented fields.

Methods inherited from class org.springframework.restdocs.snippet.TemplatedSnippet

document, getAttributes, getSnippetName

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFieldsSnippet

protected AbstractFieldsSnippet(java.lang.String type,
                                java.util.List<FieldDescriptor> descriptors,
                                java.util.Map<java.lang.String,java.lang.Object> attributes,
                                boolean ignoreUndocumentedFields)

Creates a new AbstractFieldsSnippet that will produce a snippet named <type>-fields using a template named <type>-fields. The fields will be documented using the given descriptors and 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:

type - the type of the fields

descriptors - the field descriptors

attributes - the additional attributes

ignoreUndocumentedFields - whether undocumented fields should be ignored

AbstractFieldsSnippet

protected AbstractFieldsSnippet(java.lang.String type,
                                java.util.List<FieldDescriptor> descriptors,
                                java.util.Map<java.lang.String,java.lang.Object> attributes,
                                boolean ignoreUndocumentedFields,
                                PayloadSubsectionExtractor<?> subsectionExtractor)

Creates a new AbstractFieldsSnippet that will produce a snippet named <type>-fields using a template named <type>-fields. The fields in the subsection of the payload extracted by the given subsectionExtractor will be documented using the given descriptors and 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:

type - the type of the fields

descriptors - the field descriptors

attributes - the additional attributes

ignoreUndocumentedFields - whether undocumented fields should be ignored

subsectionExtractor - the subsection extractor

Since:

1.2.0

AbstractFieldsSnippet

protected AbstractFieldsSnippet(java.lang.String name,
                                java.lang.String type,
                                java.util.List<FieldDescriptor> descriptors,
                                java.util.Map<java.lang.String,java.lang.Object> attributes,
                                boolean ignoreUndocumentedFields)

Creates a new AbstractFieldsSnippet that will produce a snippet named <name>-fields using a template named <type>-fields. The fields will be documented using the given descriptors and 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:

name - the name of the snippet

type - the type of the fields

descriptors - the field descriptors

attributes - the additional attributes

ignoreUndocumentedFields - whether undocumented fields should be ignored

AbstractFieldsSnippet

protected AbstractFieldsSnippet(java.lang.String name,
                                java.lang.String type,
                                java.util.List<FieldDescriptor> descriptors,
                                java.util.Map<java.lang.String,java.lang.Object> attributes,
                                boolean ignoreUndocumentedFields,
                                PayloadSubsectionExtractor<?> subsectionExtractor)

Creates a new AbstractFieldsSnippet that will produce a snippet named <name>-fields using a template named <type>-fields. The fields in the subsection of the payload identified by subsectionPath will be documented using the given descriptors and 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:

name - the name of the snippet

type - the type of the fields

descriptors - the field descriptors

attributes - the additional attributes

ignoreUndocumentedFields - whether undocumented fields should be ignored

subsectionExtractor - the subsection extractor documented. null or an empty string can be used to indicate that the entire payload should be documented.

Since:

1.2.0

Method Detail

createModel

protected java.util.Map<java.lang.String,java.lang.Object> createModel(Operation operation)

Description copied from class: TemplatedSnippet

Create the model that should be used during template rendering to document the given operation. Any additional attributes that were supplied when this TemplatedSnippet were created will be automatically added to the model prior to rendering.

Specified by:

createModel in class TemplatedSnippet

Parameters:

operation - the operation

Returns:

the model

getContentType

protected abstract org.springframework.http.MediaType getContentType(Operation operation)

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

Parameters:

operation - the operation

Returns:

the content type

getContent

protected abstract byte[] getContent(Operation operation)
                              throws java.io.IOException

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

Parameters:

operation - the operation

Returns:

the content

Throws:

java.io.IOException - if the content cannot be extracted

getFieldDescriptors

protected final java.util.List<FieldDescriptor> getFieldDescriptors()

Returns the list of FieldDescriptors that will be used to generate the documentation.

Returns:

the field descriptors

isIgnoredUndocumentedFields

protected final boolean isIgnoredUndocumentedFields()

Returns whether or not this snippet ignores undocumented fields.

Returns:

true if undocumented fields are ignored, otherwise false

getSubsectionExtractor

protected final PayloadSubsectionExtractor<?> getSubsectionExtractor()

Returns the PayloadSubsectionExtractor, if any, used by this snippet.

Returns:

the subsection extractor or null

Since:

1.2.4

createModelForDescriptor

protected java.util.Map<java.lang.String,java.lang.Object> createModelForDescriptor(FieldDescriptor descriptor)

Returns a model for the given descriptor.

Parameters:

descriptor - the descriptor

Returns:

the model