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 CommandFormatterCliDocumentation.multiLineFormat()Creates a newCommandFormatterthat produces multi-line output.static CommandFormatterCliDocumentation.singleLineFormat()Creates a newCommandFormatterthat produces single-line output.Methods in org.springframework.restdocs.cli with parameters of type CommandFormatterModifier and TypeMethodDescriptionstatic SnippetCliDocumentation.curlRequest(Map<String, Object> attributes, CommandFormatter commandFormatter) Returns a newSnippetthat will document the curl request for the API operation.static SnippetCliDocumentation.curlRequest(CommandFormatter commandFormatter) Returns a newSnippetthat will document the curl request for the API operation.static SnippetCliDocumentation.httpieRequest(Map<String, Object> attributes, CommandFormatter commandFormatter) Returns a newSnippetthat will document the HTTPie request for the API operation.static SnippetCliDocumentation.httpieRequest(CommandFormatter commandFormatter) Returns a newSnippetthat will document the HTTPie request for the API operation.Constructors in org.springframework.restdocs.cli with parameters of type CommandFormatterModifierConstructorDescriptionprotectedCurlRequestSnippet(Map<String, Object> attributes, CommandFormatter commandFormatter) Creates a newCurlRequestSnippetwith the given additionalattributesthat will be included in the model during template rendering.protectedCurlRequestSnippet(CommandFormatter commandFormatter) Creates a newCurlRequestSnippetthat will use the givencommandFormatterto format the curl command.protectedHttpieRequestSnippet(Map<String, Object> attributes, CommandFormatter commandFormatter) Creates a newHttpieRequestSnippetwith the given additionalattributesthat will be included in the model during template rendering.protectedHttpieRequestSnippet(CommandFormatter commandFormatter) Creates a newHttpieRequestSnippetthat will use the givencommandFormatterto format the HTTPie command.