org.springframework.restdocs.http

Class HttpRequestSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

org.springframework.restdocs.http.HttpRequestSnippet

All Implemented Interfaces:

Snippet

public class HttpRequestSnippet
extends TemplatedSnippet

A Snippet that documents an HTTP request.

Author:

Andy Wilkinson

See Also:

HttpDocumentation.httpRequest(), HttpDocumentation.httpRequest(Map)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpRequestSnippet() Creates a new HttpRequestSnippet with no additional attributes.
protected	HttpRequestSnippet(java.util.Map<java.lang.String,java.lang.Object> attributes) Creates a new HttpRequestSnippet with the given additional attributes that will be included in the model during template rendering.

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.

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

HttpRequestSnippet

protected HttpRequestSnippet()

Creates a new HttpRequestSnippet with no additional attributes.

HttpRequestSnippet

protected HttpRequestSnippet(java.util.Map<java.lang.String,java.lang.Object> attributes)

Creates a new HttpRequestSnippet with the given additional attributes that will be included in the model during template rendering.

Parameters:

attributes - The additional attributes

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