capital.scalable.restdocs.request

Class RequestHeaderSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

capital.scalable.restdocs.snippet.StandardTableSnippet

capital.scalable.restdocs.request.RequestHeaderSnippet

All Implemented Interfaces:

SectionSupport, org.springframework.restdocs.snippet.Snippet

public class RequestHeaderSnippet
extends StandardTableSnippet

Field Summary

Fields

Modifier and Type	Field and Description
static String	REQUEST_HEADERS

Constructor Summary

Constructors

Constructor and Description
RequestHeaderSnippet()
RequestHeaderSnippet(boolean failOnUndocumentedParams)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.springframework.restdocs.snippet.Attributes.Attribute	constraintAttribute(org.springframework.core.MethodParameter param, ConstraintReader constraintReader)
protected List<org.springframework.restdocs.payload.FieldDescriptor>	createFieldDescriptors(org.springframework.restdocs.operation.Operation operation, org.springframework.web.method.HandlerMethod handlerMethod)
protected org.springframework.restdocs.snippet.Attributes.Attribute	defaultValueAttribute(A annot)
protected org.springframework.restdocs.snippet.Attributes.Attribute	deprecatedAttribute(org.springframework.core.MethodParameter param, A annot, JavadocReader javadocReader)
RequestHeaderSnippet	failOnUndocumentedParams(boolean failOnUndocumentedParams)
protected org.springframework.web.bind.annotation.RequestHeader	getAnnotation(org.springframework.core.MethodParameter param)
protected String	getDefaultValue(org.springframework.web.bind.annotation.RequestHeader annotation)
String	getFileName() File name (= section name).
String	getHeaderKey() Section header key corresponding to entry in translation file.
protected String	getPath(org.springframework.web.bind.annotation.RequestHeader annot)
protected String[]	getTranslationKeys()
boolean	hasContent(org.springframework.restdocs.operation.Operation operation) Flag if section will render non-empty content.
protected boolean	isCustomDefaultValue(String defaultValue)
protected boolean	isRequired(org.springframework.core.MethodParameter param, org.springframework.web.bind.annotation.RequestHeader annot)
protected org.springframework.restdocs.snippet.Attributes.Attribute	optionalsAttribute(org.springframework.core.MethodParameter param, A annot)
protected boolean	shouldFailOnUndocumentedParams()

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

createModel, createModelForDescriptor, enrichModel

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

REQUEST_HEADERS

public static final String REQUEST_HEADERS

See Also:

Constant Field Values

Constructor Detail

RequestHeaderSnippet

public RequestHeaderSnippet()

RequestHeaderSnippet

public RequestHeaderSnippet(boolean failOnUndocumentedParams)

Method Detail

failOnUndocumentedParams

public RequestHeaderSnippet failOnUndocumentedParams(boolean failOnUndocumentedParams)

isRequired

protected boolean isRequired(org.springframework.core.MethodParameter param,
                 org.springframework.web.bind.annotation.RequestHeader annot)

getPath

protected String getPath(org.springframework.web.bind.annotation.RequestHeader annot)

getAnnotation

protected org.springframework.web.bind.annotation.RequestHeader getAnnotation(org.springframework.core.MethodParameter param)

getHeaderKey

public String getHeaderKey()

Description copied from interface: SectionSupport

Section header key corresponding to entry in translation file.

shouldFailOnUndocumentedParams

protected boolean shouldFailOnUndocumentedParams()

getDefaultValue

protected String getDefaultValue(org.springframework.web.bind.annotation.RequestHeader annotation)

getTranslationKeys

protected String[] getTranslationKeys()

Specified by:

getTranslationKeys in class StandardTableSnippet

createFieldDescriptors

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

Specified by:

createFieldDescriptors in class StandardTableSnippet

isCustomDefaultValue

protected boolean isCustomDefaultValue(String defaultValue)

constraintAttribute

protected org.springframework.restdocs.snippet.Attributes.Attribute constraintAttribute(org.springframework.core.MethodParameter param,
                                                                            ConstraintReader constraintReader)

optionalsAttribute

protected org.springframework.restdocs.snippet.Attributes.Attribute optionalsAttribute(org.springframework.core.MethodParameter param,
                                                                           A annot)

deprecatedAttribute

protected org.springframework.restdocs.snippet.Attributes.Attribute deprecatedAttribute(org.springframework.core.MethodParameter param,
                                                                            A annot,
                                                                            JavadocReader javadocReader)

defaultValueAttribute

protected org.springframework.restdocs.snippet.Attributes.Attribute defaultValueAttribute(A annot)

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