Uses of Interface
org.springframework.restdocs.cli.CommandFormatter
Packages that use CommandFormatter
Package
Description
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 CommandFormatterModifier and TypeMethodDescriptionstatic CommandFormatter
CliDocumentation.multiLineFormat()
Creates a newCommandFormatter
that produces multi-line output.static CommandFormatter
CliDocumentation.singleLineFormat()
Creates a newCommandFormatter
that produces single-line output.Methods in org.springframework.restdocs.cli with parameters of type CommandFormatterModifier and TypeMethodDescriptionstatic Snippet
CliDocumentation.curlRequest
(Map<String, Object> attributes, CommandFormatter commandFormatter) Returns a newSnippet
that will document the curl request for the API operation.static Snippet
CliDocumentation.curlRequest
(CommandFormatter commandFormatter) Returns a newSnippet
that will document the curl request for the API operation.static Snippet
CliDocumentation.httpieRequest
(Map<String, Object> attributes, CommandFormatter commandFormatter) Returns a newSnippet
that will document the HTTPie request for the API operation.static Snippet
CliDocumentation.httpieRequest
(CommandFormatter commandFormatter) Returns a newSnippet
that will document the HTTPie request for the API operation.Constructors in org.springframework.restdocs.cli with parameters of type CommandFormatterModifierConstructorDescriptionprotected
CurlRequestSnippet
(Map<String, Object> attributes, CommandFormatter commandFormatter) Creates a newCurlRequestSnippet
with the given additionalattributes
that will be included in the model during template rendering.protected
CurlRequestSnippet
(CommandFormatter commandFormatter) Creates a newCurlRequestSnippet
that will use the givencommandFormatter
to format the curl command.protected
HttpieRequestSnippet
(Map<String, Object> attributes, CommandFormatter commandFormatter) Creates a newHttpieRequestSnippet
with the given additionalattributes
that will be included in the model during template rendering.protected
HttpieRequestSnippet
(CommandFormatter commandFormatter) Creates a newHttpieRequestSnippet
that will use the givencommandFormatter
to format the HTTPie command.