capital.scalable.restdocs.payload

Class JacksonResponseFieldSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

capital.scalable.restdocs.snippet.StandardTableSnippet

capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

All Implemented Interfaces:

SectionSupport, org.springframework.restdocs.snippet.Snippet

public class JacksonResponseFieldSnippet
extends StandardTableSnippet

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESPONSE_FIELDS
static String	SPRING_DATA_PAGE_CLASS

Constructor Summary

Constructors

Constructor and Description
JacksonResponseFieldSnippet()
JacksonResponseFieldSnippet(Type responseBodyType, boolean failOnUndocumentedFields)

Method Summary

Methods

Modifier and Type	Method and Description
protected Collection<org.springframework.restdocs.payload.FieldDescriptor>	createFieldDescriptors(org.springframework.restdocs.operation.Operation operation, org.springframework.web.method.HandlerMethod handlerMethod)
protected void	enrichModel(Map<String,Object> model, org.springframework.web.method.HandlerMethod handlerMethod)
JacksonResponseFieldSnippet	failOnUndocumentedFields(boolean failOnUndocumentedFields)
protected Type	firstGenericType(org.springframework.core.MethodParameter param)
String	getFileName() File name (= section name).
String	getHeaderKey() Section header key corresponding to entry in translation file.
protected String[]	getTranslationKeys()
protected Type	getType(org.springframework.web.method.HandlerMethod method)
boolean	hasContent(org.springframework.restdocs.operation.Operation operation) Flag if section will render non-empty content.
protected boolean	isCollection(Class<?> type)
JacksonResponseFieldSnippet	responseBodyAsType(Type responseBodyType)
protected boolean	shouldFailOnUndocumentedFields()

Methods inherited from class capital.scalable.restdocs.snippet.StandardTableSnippet

createModel, createModelForDescriptor

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

Field Detail

RESPONSE_FIELDS

public static final String RESPONSE_FIELDS

See Also:

Constant Field Values

SPRING_DATA_PAGE_CLASS

public static final String SPRING_DATA_PAGE_CLASS

See Also:

Constant Field Values

Constructor Detail

JacksonResponseFieldSnippet

public JacksonResponseFieldSnippet()

JacksonResponseFieldSnippet

public JacksonResponseFieldSnippet(Type responseBodyType,
                           boolean failOnUndocumentedFields)

Method Detail

responseBodyAsType

public JacksonResponseFieldSnippet responseBodyAsType(Type responseBodyType)

failOnUndocumentedFields

public JacksonResponseFieldSnippet failOnUndocumentedFields(boolean failOnUndocumentedFields)

getType

protected Type getType(org.springframework.web.method.HandlerMethod method)

enrichModel

protected void enrichModel(Map<String,Object> model,
               org.springframework.web.method.HandlerMethod handlerMethod)

Overrides:

enrichModel in class StandardTableSnippet

getHeaderKey

public String getHeaderKey()

Description copied from interface: SectionSupport

Section header key corresponding to entry in translation file.

shouldFailOnUndocumentedFields

protected boolean shouldFailOnUndocumentedFields()

getTranslationKeys

protected String[] getTranslationKeys()

Specified by:

getTranslationKeys in class StandardTableSnippet

createFieldDescriptors

protected Collection<org.springframework.restdocs.payload.FieldDescriptor> createFieldDescriptors(org.springframework.restdocs.operation.Operation operation,
                                                                                      org.springframework.web.method.HandlerMethod handlerMethod)

Specified by:

createFieldDescriptors in class StandardTableSnippet

firstGenericType

protected Type firstGenericType(org.springframework.core.MethodParameter param)

isCollection

protected boolean isCollection(Class<?> type)

getFileName

public String getFileName()

Description copied from interface: SectionSupport

File name (= section name).

Specified by:

getFileName in interface SectionSupport

hasContent

public boolean hasContent(org.springframework.restdocs.operation.Operation operation)

Description copied from interface: SectionSupport

Flag if section will render non-empty content.

Specified by:

hasContent in interface SectionSupport

Parameters:

operation - operation

Returns:

true if snippet will return non-empty content; false otherwise