public class HttpieRequestSnippet extends TemplatedSnippet
Snippet
that documents the HTTPie command for a request.CliDocumentation.httpieRequest()
,
CliDocumentation.httpieRequest(Map)
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(Map<String,Object> attributes)
Deprecated.
since 1.2.0 in favor of
HttpieRequestSnippet(Map, CommandFormatter) |
protected |
HttpieRequestSnippet(Map<String,Object> attributes,
CommandFormatter commandFormatter)
Creates a new
HttpieRequestSnippet with the given additional
attributes that will be included in the model during template rendering. |
Modifier and Type | Method and Description |
---|---|
protected Map<String,Object> |
createModel(Operation operation)
Create the model that should be used during template rendering to document the
given
operation . |
document, getAttributes, getSnippetName
@Deprecated protected HttpieRequestSnippet()
HttpieRequestSnippet(CommandFormatter)
HttpieRequestSnippet
with no additional attributes.protected HttpieRequestSnippet(CommandFormatter commandFormatter)
HttpieRequestSnippet
that will use the given
commandFormatter
to format the HTTPie command.commandFormatter
- The formatter@Deprecated protected HttpieRequestSnippet(Map<String,Object> attributes)
HttpieRequestSnippet(Map, CommandFormatter)
HttpieRequestSnippet
with the given additional
attributes
that will be included in the model during template rendering.attributes
- The additional attributesprotected HttpieRequestSnippet(Map<String,Object> attributes, CommandFormatter commandFormatter)
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.attributes
- The additional attributescommandFormatter
- The formatter for generating the snippetprotected Map<String,Object> createModel(Operation operation)
TemplatedSnippet
operation
. Any additional attributes that were supplied when this
TemplatedSnippet
were created will be automatically added to the model
prior to rendering.createModel
in class TemplatedSnippet
operation
- The operation