org.springframework.restdocs.http

Class HttpDocumentation

java.lang.Object

org.springframework.restdocs.http.HttpDocumentation

public abstract class HttpDocumentation
extends 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 Snippet	httpRequest() Returns a handler that will produce a snippet containing the HTTP request for the API call.
static Snippet	httpRequest(Map<String,Object> attributes) Returns a handler that will produce a snippet containing the HTTP request for the API call.
static Snippet	httpResponse() Returns a handler that will produce a snippet containing the HTTP response for the API call.
static Snippet	httpResponse(Map<String,Object> attributes) Returns a handler that will produce a snippet containing the HTTP response for the API call.

Methods inherited from class java.lang.Object

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

Method Detail

httpRequest

public static Snippet httpRequest()

Returns a handler that will produce a snippet containing the HTTP request for the API call.

Returns:

the handler that will produce the snippet

httpRequest

public static Snippet httpRequest(Map<String,Object> attributes)

Returns a handler that will produce a snippet containing the HTTP request for the API call. The given attributes will be available during snippet generation.

Parameters:

attributes - the attributes

Returns:

the handler that will produce the snippet

httpResponse

public static Snippet httpResponse()

Returns a handler that will produce a snippet containing the HTTP response for the API call.

Returns:

the handler that will produce the snippet

httpResponse

public static Snippet httpResponse(Map<String,Object> attributes)

Returns a handler that will produce a snippet containing the HTTP response for the API call. The given attributes will be available during snippet generation.

Parameters:

attributes - the attributes

Returns:

the handler that will produce the snippet