Uses of Interface
org.springframework.restdocs.cli.CommandFormatter

Packages that use CommandFormatter

Package	Description
org.springframework.restdocs.cli	Documenting CLI commands required to make a request to a RESTful API.

Uses of CommandFormatter in org.springframework.restdocs.cli

Methods in org.springframework.restdocs.cli that return CommandFormatter

Modifier and Type	Method and Description
static CommandFormatter	CliDocumentation.multiLineFormat() Creates a new CommandFormatter that produces multi-line output.
static CommandFormatter	CliDocumentation.singleLineFormat() Creates a new CommandFormatter that produces single-line output.

Methods in org.springframework.restdocs.cli with parameters of type CommandFormatter

Modifier and Type	Method and Description
static Snippet	CliDocumentation.curlRequest(CommandFormatter commandFormatter) Returns a new Snippet that will document the curl request for the API operation.
static Snippet	CliDocumentation.curlRequest(java.util.Map<java.lang.String,java.lang.Object> attributes, CommandFormatter commandFormatter) Returns a new Snippet that will document the curl request for the API operation.
static Snippet	CliDocumentation.httpieRequest(CommandFormatter commandFormatter) Returns a new Snippet that will document the HTTPie request for the API operation.
static Snippet	CliDocumentation.httpieRequest(java.util.Map<java.lang.String,java.lang.Object> attributes, CommandFormatter commandFormatter) Returns a new Snippet that will document the HTTPie request for the API operation.

Constructors in org.springframework.restdocs.cli with parameters of type CommandFormatter

Constructor and Description
CurlRequestSnippet(CommandFormatter commandFormatter) Creates a new CurlRequestSnippet that will use the given commandFormatter to format the curl command.
CurlRequestSnippet(java.util.Map<java.lang.String,java.lang.Object> attributes, CommandFormatter commandFormatter) Creates a new CurlRequestSnippet with the given additional attributes that will be included in the model during template rendering.
HttpieRequestSnippet(CommandFormatter commandFormatter) Creates a new HttpieRequestSnippet that will use the given commandFormatter to format the HTTPie command.
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.