public class CurlRequestSnippet extends TemplatedSnippet
Snippet that documents the curl command for a request.CliDocumentation.curlRequest(),
CliDocumentation.curlRequest(CommandFormatter),
CliDocumentation.curlRequest(Map)| Modifier | Constructor and Description |
|---|---|
protected |
CurlRequestSnippet(CommandFormatter commandFormatter)
Creates a new
CurlRequestSnippet that will use the given
commandFormatter to format the curl command. |
protected |
CurlRequestSnippet(Map<String,Object> attributes,
CommandFormatter commandFormatter)
Creates a new
CurlRequestSnippet 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, getSnippetNameprotected CurlRequestSnippet(CommandFormatter commandFormatter)
CurlRequestSnippet that will use the given
commandFormatter to format the curl command.commandFormatter - the formatterprotected CurlRequestSnippet(Map<String,Object> attributes, CommandFormatter commandFormatter)
CurlRequestSnippet with the given additional
attributes that will be included in the model during template rendering.
The given commandFormaatter will be used to format the curl command.attributes - the additional attributescommandFormatter - the formatter for generating the snippetprotected Map<String,Object> createModel(Operation operation)
TemplatedSnippetoperation. Any additional attributes that were supplied when this
TemplatedSnippet were created will be automatically added to the model
prior to rendering.createModel in class TemplatedSnippetoperation - the operation