capital.scalable.restdocs.payload

Class JacksonResponseFieldSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

capital.scalable.restdocs.snippet.StandardTableSnippet

capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

capital.scalable.restdocs.payload.JacksonResponseFieldSnippet

All Implemented Interfaces:

SectionSupport, org.springframework.restdocs.snippet.Snippet

public class JacksonResponseFieldSnippet
extends AbstractJacksonFieldSnippet

Field Summary

Fields

Modifier and Type	Field and Description
static String	REACTOR_FLUX_CLASS
static String	REACTOR_MONO_CLASS
static Set<String>	SPRING_HATEOAS_CLASSES

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	enrichModel(Map<String,Object> model, org.springframework.web.method.HandlerMethod handlerMethod, FieldDescriptors fieldDescriptors, SnippetTranslationResolver translationResolver)
JacksonResponseFieldSnippet	failOnUndocumentedFields(boolean failOnUndocumentedFields)
String	getHeaderKey(org.springframework.restdocs.operation.Operation operation) Section header key corresponding to entry in translation file.
protected com.fasterxml.jackson.annotation.JsonProperty.Access	getSkipAcessor()
protected String[]	getTranslationKeys()
protected Type	getType(org.springframework.web.method.HandlerMethod method)
JacksonResponseFieldSnippet	responseBodyAsType(Type responseBodyType)
protected boolean	shouldFailOnUndocumentedFields()

Methods inherited from class capital.scalable.restdocs.payload.AbstractJacksonFieldSnippet

createFieldDescriptors, getFileName, hasContent, isCollection

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

Methods inherited from interface capital.scalable.restdocs.section.SectionSupport

isMergeable

Field Detail

SPRING_HATEOAS_CLASSES

public static final Set<String> SPRING_HATEOAS_CLASSES

REACTOR_MONO_CLASS

public static final String REACTOR_MONO_CLASS

See Also:

Constant Field Values

REACTOR_FLUX_CLASS

public static final String REACTOR_FLUX_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)

Specified by:

getType in class AbstractJacksonFieldSnippet

enrichModel

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

Overrides:

enrichModel in class StandardTableSnippet

getHeaderKey

public String getHeaderKey(org.springframework.restdocs.operation.Operation operation)

Description copied from interface: SectionSupport

Section header key corresponding to entry in translation file.

Parameters:

operation - operation

shouldFailOnUndocumentedFields

protected boolean shouldFailOnUndocumentedFields()

Specified by:

shouldFailOnUndocumentedFields in class AbstractJacksonFieldSnippet

getTranslationKeys

protected String[] getTranslationKeys()

Specified by:

getTranslationKeys in class StandardTableSnippet

getSkipAcessor

protected com.fasterxml.jackson.annotation.JsonProperty.Access getSkipAcessor()

Overrides:

getSkipAcessor in class AbstractJacksonFieldSnippet