public abstract class HttpDocumentation extends Object
Modifier and Type | Method and Description |
---|---|
static HttpRequestSnippet |
httpRequest()
Returns a new
Snippet that will document the HTTP request for the API
operation. |
static HttpRequestSnippet |
httpRequest(Map<String,Object> attributes)
Returns a new
Snippet that will document the HTTP request for the API
operation. |
static HttpResponseSnippet |
httpResponse()
Returns a
Snippet that will document the HTTP response for the API
operation. |
static HttpResponseSnippet |
httpResponse(Map<String,Object> attributes)
Returns a
Snippet that will document the HTTP response for the API
operation. |
public static HttpRequestSnippet httpRequest()
Snippet
that will document the HTTP request for the API
operation.public static HttpRequestSnippet httpRequest(Map<String,Object> attributes)
Snippet
that will document the HTTP request for the API
operation. The given attributes
will be available during snippet
generation.attributes
- the attributespublic static HttpResponseSnippet httpResponse()
Snippet
that will document the HTTP response for the API
operation.public static HttpResponseSnippet httpResponse(Map<String,Object> attributes)
Snippet
that will document the HTTP response for the API
operation. The given attributes
will be available during snippet
generation.attributes
- the attributes