org.springframework.restdocs.cli

Class HttpieRequestSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

org.springframework.restdocs.cli.HttpieRequestSnippet

All Implemented Interfaces:

Snippet

public class HttpieRequestSnippet
extends TemplatedSnippet

A Snippet that documents the HTTPie command for a request.

Since:

1.1.0

Author:

Raman Gupta, Andy Wilkinson, Tomasz Kopczynski

See Also:

CliDocumentation.httpieRequest(), CliDocumentation.httpieRequest(Map)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpieRequestSnippet() Deprecated. since 1.2.0 in favor of HttpieRequestSnippet(CommandFormatter)
protected	HttpieRequestSnippet(CommandFormatter commandFormatter) Creates a new HttpieRequestSnippet that will use the given commandFormatter to format the HTTPie command.
protected	HttpieRequestSnippet(java.util.Map<java.lang.String,java.lang.Object> attributes) Deprecated. since 1.2.0 in favor of HttpieRequestSnippet(Map, CommandFormatter)
protected	HttpieRequestSnippet(java.util.Map<java.lang.String,java.lang.Object> attributes, CommandFormatter commandFormatter) Creates a new HttpieRequestSnippet 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

HttpieRequestSnippet

@Deprecated
protected HttpieRequestSnippet()

Deprecated. since 1.2.0 in favor of HttpieRequestSnippet(CommandFormatter)

Creates a new HttpieRequestSnippet with no additional attributes.

HttpieRequestSnippet

protected HttpieRequestSnippet(CommandFormatter commandFormatter)

Creates a new HttpieRequestSnippet that will use the given commandFormatter to format the HTTPie command.

Parameters:

commandFormatter - The formatter

HttpieRequestSnippet

@Deprecated
protected HttpieRequestSnippet(java.util.Map<java.lang.String,java.lang.Object> attributes)

Deprecated. since 1.2.0 in favor of HttpieRequestSnippet(Map, CommandFormatter)

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

Parameters:

attributes - The additional attributes

HttpieRequestSnippet

protected HttpieRequestSnippet(java.util.Map<java.lang.String,java.lang.Object> attributes,
                               CommandFormatter commandFormatter)

Creates a new HttpieRequestSnippet with the given additional attributes that will be included in the model during template rendering. The given commandFormaatter will be used to format the HTTPie command.

Parameters:

attributes - The additional attributes

commandFormatter - The formatter for generating the snippet

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