org.springframework.restdocs.http

Class HttpDocumentation

java.lang.Object

org.springframework.restdocs.http.HttpDocumentation

public abstract class HttpDocumentation
extends java.lang.Object

Static factory methods for documenting a RESTful API's HTTP requests.

Author:

Andy Wilkinson, Jonathan Pearlin

Method Summary

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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.Object> attributes) Returns a Snippet that will document the HTTP response for the API operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

httpRequest

public static HttpRequestSnippet httpRequest()

Returns a new Snippet that will document the HTTP request for the API operation.

Returns:

the snippet that will document the HTTP request

httpRequest

public static HttpRequestSnippet httpRequest(java.util.Map<java.lang.String,java.lang.Object> attributes)

Returns a new Snippet that will document the HTTP request for the API operation. The given attributes will be available during snippet generation.

Parameters:

attributes - the attributes

Returns:

the snippet that will document the HTTP request

httpResponse

public static HttpResponseSnippet httpResponse()

Returns a Snippet that will document the HTTP response for the API operation.

Returns:

the snippet that will document the HTTP response

httpResponse

public static HttpResponseSnippet httpResponse(java.util.Map<java.lang.String,java.lang.Object> attributes)

Returns a Snippet that will document the HTTP response for the API operation. The given attributes will be available during snippet generation.

Parameters:

attributes - the attributes

Returns:

the snippet that will document the HTTP response